diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7ef8bda5..6ebf29a3 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,72 +1,101 @@ +1. The Open Source LabVIEW Icon Editor +1. Our Contributing Philosophy +1. How to contribute +1. Collaborate with the community and NI! +1. Creating a discussion for a new feature +1. Enhancements +1. Reporting issues + + + # The Open Source LabVIEW Icon Editor 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. -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). +The direction of the LabVIEW Icon Editor and which new features are added, and which are left out, is decided by the steering committee, 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. + + # Our Contributing Philosophy -This repo is managed via [git](https://git-scm.com), with the canonical upstream repository hosted on [GitHub](https://github.com/ni/labview-icon-editor) and it follows a pull-request model for development. If you wish to contribute, you will need to create a GitHub account, fork this project, push a branch with your changes to your project, and then submit a pull request. +This repo is managed via [git](https://git-scm.com), with the canonical upstream repository hosted on [GitHub](https://github.com/ni/labview-icon-editor) and it follows a pull-request model for development. -# How can I help? +Feature requests are selected by NI in a joint effort with a group of members of the LabVIEW community called a "steering committee". A steering committee is a group of trusted individuals selected by the software community lead based on their background and contribution history to the NI ecosystem. -The things we need the most help for the library and its community are: +Steering committees are non-NI employees with triage roles to the repo that can vote on community driven features being part of the next LabVIEW release. -**🐛 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 and provide feedback**: New features begin by creating a discussion on our [board](https://github.com/ni/labview-icon-editor/discussions/new?category=ideas), you can provide feedback to the new features that are planned to be added to the icon editor. This is an [example](https://github.com/ni/labview-icon-editor/discussions/55) of a discussion for a new feature request. +# Collaborate with the community and NI! +Ready to level up your game?. Collaborate with people from different backgrounds and proficiency levels. -🎬 **Work on ["Good first issue"**](https://github.com/ni/labview-icon-editor/labels/good%20first%20issue) items: You can right now assign yourself action items to finish or test a feature. Check out the [issues](https://github.com/ni/labview-icon-editor/issues) section and look for any issue labeled as [Good first issue](https://github.com/ni/labview-icon-editor/labels/good%20first%20issue). +See below the different ways to collaborate -**✏️ Edit our [Docs](https://labview-icon-editor.dev/docs/introduction/)**: Make changes in the [labview-icon-editor-docs repo](https://github.com/ni/labview-icon-editor-docs), or click the "edit this page” button that lives on every doc site. +| Contribution type | Effort level(1-10) | +|-------------------|--------------| +| Comment on GitHub issues | 1 | +| Comment on GitHub discussions | 1 | +| Create a GitHub discussion | 2 | +| Report an issue | 2 | +| Develop a feature | 8 to 10 | +| Solve a bug | 5 to 10 | -All interactions should be done with care following our [Code of Conduct](https://github.com/ni/labview-icon-editor/blob/main/CODE_OF_CONDUCT.md). + + +## Comment on GitHub issues + +Go to the [issues](https://github.com/ni/labview-icon-editor/issues) section of the repo and voice your opinion on issues that other people are having. Did you find a workaround to any of the GitHub issues? We want to hear about it! + + + +## Comment on GitHub discussions + +[GitHub discussions](https://github.com/ni/labview-icon-editor/discussions) are raw ideas in the process of gathering feedback from the community before converting them into a GitHub issue. Go to the GitHub discussions and voice your opinion on ideas that will eventually be a part of the next shipping version of the Icon Editor. + + + +## Create a GitHub discussion + +Want things done differently? or have an idea on a feature that is not ready yet to be considered as a GitHub issue? + +Create a [GitHub discussion](https://github.com/ni/labview-icon-editor/discussions/new/choose) so that other member of the LabVIEW community can weigh in on your dicsussion. Discussions are usually initial stage for GitHub issues. + + -## Enhancements +## Report an issue -If you have an idea or suggestion for an enhancement to the LabVIEW Icon Editor library, please use the [New Features](https://github.com/ni/labview-icon-editor/discussions/categories/new-features) discussion section. **please make sure to start a discussion about your changes.** 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](https://github.com/ni/labview-icon-editor/discussions/categories/new-features), and in the end, they are decided by the core team. +Found an issue? [raise a new GitHub issue](https://github.com/ni/labview-icon-editor/issues/new/choose) and select "Bug Report" + + + +## Develop features and bugfixes with NI and the LabVIEW community + + You can do this by becoming a contributor. + +Contributions for bug resolution and feature development have certain guidelines and processes not covered on this document. More information can be found [here](https://github.com/ni/labview-icon-editor/wiki). + +* ## Feature development + +Try developing a new feature by going into the GitHub issues labeled as [Workflow: Open to contribution](https://github.com/ni/labview-icon-editor/issues?q=is%3Aissue%20label%3A%22Workflow%3A%20Open%20to%20contribution%22). Go to the GitHub issue you want to work on, and let us know via a comment. + + + +* ## Solve a bug + +Go to the GitHub issues marked as bugs that are open for contribution [here](https://github.com/ni/labview-icon-editor/issues?q=is%3Aissue%20label%3A%22Workflow%3A%20Open%20to%20contribution%22%20type%3ABug). + + + +# Enhancements + +If you have an idea or suggestion for an enhancement to the LabVIEW Icon Editor library, please use the [New Features](https://github.com/ni/labview-icon-editor/discussions/categories/new-features) discussion section. **please make sure to start a discussion about your changes.** Talking to us first via the discussions section 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. Once your idea has been selected for the next release of LabVIEW, a branch will be created that you can submit your pull request to. -## Creating a discussion for a new feature - -The first step to start an enhancement to the icon editor is to create a discussion on the [New Features](https://github.com/ni/labview-icon-editor/discussions/categories/new-features) discussion board. You must describe the problem that made you want to have this enhancement. - -### 💫 Pull Requests - -When submitting a PR, please follow these guidelines to ensure clarity and ease -of review: - -1. **Title**: Start with a short, descriptive title that summarizes the change. -2. **Description**: - - **Purpose**: Explain why you are making this change. - - **Changes Made**: Describe what changes you made and why. - - **Related Issues**: Reference any related issues using `#issue_number`. - - **Testing**: Outline how you tested your changes and any specific areas of - the code to focus on during review. - -Please remember to sign off your commits (e.g., by using git commit -s if you -are using the command line client). This amends your git commit message with a -line of the form Signed-off-by: Name Lastname . -Please include all authors of any given commit into the commit message with a -Signed-off-by line. This indicates that you have read and signed the Developer -Certificate of Origin (see below) and are able to legally submit your code to -this repository. - -### Reporting Issues - -When creating an issue, please provide a detailed description to help us -understand the problem. Here are some tips: - -1. **Title**: Use a clear, concise title that summarizes the issue. -2. **Description**: - - **What Happened**: Describe the issue you encountered. - - **Expected Behavior**: Explain what you expected to happen. - - **Steps to Reproduce**: List the steps necessary to reproduce the issue. - - **Environment**: Include relevant details about your environment (e.g., - operating system, LabVIEW version, etc.). - - **Screenshots**: If applicable, add screenshots to clarify the issue. + + +All interactions should be done with care following our [Code of Conduct](https://github.com/ni/labview-icon-editor/blob/main/CODE_OF_CONDUCT.md).