Update CONTRIBUTING.md #54
Conversation
Adding more details
CONTRIBUTING.md
Outdated
| * The latest version of the LabVIEW Icon Editor (not published yet) can be found {latest_version_link} | ||
|
|
||
| # Our Contributing Philosophy | ||
| Just recently, the LabVIEW Icon Editor has been made open source to encourage collaboration between NI and the LabVIEW Community. Every new build of LabVIEW will grab the icon editor that has been pushed into the main branch from this repo. |
There was a problem hiding this comment.
Use backticks when referencing the main branch to avoid any ambiguity that "main" is the name of the branch and not just the default branch. @svelderrainruiz
CONTRIBUTING.md
Outdated
| # How can I help? | ||
|
|
||
| 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](https://github.com/ni/labview-icon-editor/issues/new/choose) and discussion first, then [create a new issue](https://github.com/ni/labview-icon-editor/issues/new/choose) to tell us what’s up. | ||
|
|
||
| **💬 Answering questions** in our {discussion_form} or {community_discord}. | ||
| **💬 Answering questions and provide feedback**: New features begin by creating a discussion on our board, you can provide feedback to the new features that are planned to be added to the icon editor. |
There was a problem hiding this comment.
Make "our discussion board" a link to the actual discussion board. @svelderrainruiz
There was a problem hiding this comment.
[discussion form](https://github.com/ni/labview-icon-editor/discussions)
CONTRIBUTING.md
Outdated
|
|
||
| 🎬 **Create tutorials**. Send them to us and we’ll happily share them! | ||
| 🎬 **Work on "Good first issue" items**: You can right now assign yourself action items to finish or test a feature. Check out the issues section and look for any issue labeled as "Good first problem" if you want to passively contribute to the repo, or if you are feeling adventurous you can always assign problems not labeled as "Good first issue". |
There was a problem hiding this comment.
Make "good first issues" text a link to the issues list, filtered to only show "good for issues" @svelderrainruiz
There was a problem hiding this comment.
Like this Good First Issues
[Good First Issues](https://github.com/ni/labview-icon-editor/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22)
| 2. {step_2} | ||
| 3. Test your changes by editing the icons of some VIs | ||
| 4. Run tests `caraya` and add new tests if you are introducing a new feature | ||
| When submitting a PR, please follow these guidelines to ensure clarity and ease |
There was a problem hiding this comment.
@svelderrainruiz It's possible to set up a template where a user can fill in the blanks almost like a form. @svelderrainruiz
There was a problem hiding this comment.
| Certificate of Origin (see below) and are able to legally submit your code to | ||
| this repository. | ||
|
|
||
| ### Reporting Issues |
There was a problem hiding this comment.
@svelderrainruiz I'm not at my computer, but if you remind me, I can point you to how to set up templates for issues/pull-requests
added links and removed additional text
Adding more details