Hello there! So glad you want to help out with the LabVIEW Icon Editor 🤗 You’re the best. Here’s a guide for how you can contribute to the project.
Just recently, the LabVIEW Icon Editor has been made open source to encourage collaboration between NI and the LabVIEW Community. Now you can find the source code of the LabVIEW Icon Editor in this repository. We are in a state of transition. This is the current structure:
- LabVIEW Icon Editor
labview-icon-editor
version {latest_version} is on branch {branch_name} - The latest version of the LabVIEW Icon Editor (not published yet) can be found {latest_version_link}
The direction of the LabVIEW Icon Editor and which new features are added, and which are left out, is decided by the core team, which includes NI staff and LabVIEW community volunteers (sometimes referred to as a “cathedral” style of development).
That being said, the Icon Editor is great because of the LabVIEW users who use it, share their code with the community, and discuss ways to make LabVIEW even better. Some of the most important and undervalued work in open source is from non-code contributions, and that is where we can use the most help from you.
The things we need the most help for the library and its community are:
🐛 Bug reports: We simply can’t catch them all. Check existing issues and discussion first, then create a new issue to tell us what’s up.
💬 Answering questions in our {discussion_form} or {community_discord}.
🎬 Create tutorials. Send them to us and we’ll happily share them!
✏️ Edit our Docs: Make changes in the labview-icon-editor-docs repo, or click the "edit this page” button that lives on every doc site.
All interactions should be done with care following our Code of Conduct.
If you have an idea or suggestion for an enhancement to the LabVIEW Icon Editor library, please use the New Features discussion section. If you want to build it yourself, please reach out to us before you dive into a new pull request. The direction of the LabVIEW Icon Editor and which new features are added are discussed in our Discord Server and in this GitHub discussions section, and in the end, they are decided by the core team.
Talking to us first about the enhancement you want to build will be the most likely way to get your pull request into the library (see Our Contributing Philosophy above). We would hate to see you write code you’re proud of, just to learn that we’ve already been working on the same thing, or that we feel doesn’t fit into the core library.
To ask about a possible enhancement, email us at {team_email_address}
If you want to contribute improvements or new features, we are happy to review your PR :)
Please use a meaningful commit message and add a little description of your changes.
- Install package dependencies
dragon install
- {step_2}
- Test your changes by editing the icons of some VIs
- Run tests
caraya
and add new tests if you are introducing a new feature