|
| 1 | +# Contribution Guide |
| 2 | + |
| 3 | +Thank you for your interest in contributing to our project! We strive to maintain a welcoming and inclusive community. |
| 4 | + |
| 5 | +## Ways to Contribute |
| 6 | + |
| 7 | +There are multiple ways you can contribute to this project: |
| 8 | + |
| 9 | +1. **Report an Issue**: If you encounter a bug or have a suggestion, please open an issue on our |
| 10 | +[GitHub Issues page](https://github.com/Open-CMSIS-Pack/devtools/issues) to start the discussion about your proposal. |
| 11 | + |
| 12 | +2. **Open a Pull Request**: Contributions are welcome, whether you're fixing a bug, adding a new feature, or improving |
| 13 | +documentation. You can submit a pull request to our |
| 14 | +[GitHub repository](https://github.com/Open-CMSIS-Pack/devtools/pulls) to: |
| 15 | + - Provide a bug fix |
| 16 | + - Add new features or enhancements |
| 17 | + - Improve or expand existing documentation |
| 18 | + |
| 19 | +### Report an Issue |
| 20 | + |
| 21 | +Please feel free to raise an [issue on GitHub](https://github.com/Open-CMSIS-Pack/Open-CMSIS-Pack/issues) |
| 22 | +to report misbehavior (i.e. bugs) |
| 23 | + |
| 24 | +Issues are your best way to interact directly with the maintenance team and the community. |
| 25 | +We encourage you to append implementation suggestions as this helps to decrease the |
| 26 | +workload of the very limited maintenance team. |
| 27 | + |
| 28 | +We shall be monitoring and responding to issues as best we can. |
| 29 | +Please attempt to avoid filing duplicates of open or closed items when possible. |
| 30 | +In the spirit of openness we shall be tagging issues with the following: |
| 31 | + |
| 32 | +- **bug** – This issue is identified as a bug and will be investigated. |
| 33 | +- **discussion** – This issue is currently under discussion. |
| 34 | +- **discussion done** – The discussion on this issue is complete. |
| 35 | +- **documentation** – This issue highlights a documentation gap, which will be addressed in future updates. |
| 36 | +- **duplicate** – This issue duplicates an existing one; see comments for related references. |
| 37 | +- **enhancement** – This issue represents a request for a new feature or improvement. |
| 38 | +- **question** – We need further information or clarification on this issue; please review and respond. |
| 39 | +- **wontfix** – While we appreciate this suggestion, we have decided not to make changes at this time. |
| 40 | + |
| 41 | +### Open a Pull Request |
| 42 | + |
| 43 | +We encourage contributions of all sizes, but please keep each contribution focused and independent. We prefer smaller, |
| 44 | +more manageable pull requests, which makes it easier for us to review, provide feedback, and merge changes quickly. |
| 45 | + |
| 46 | +#### Contribution Process |
| 47 | + |
| 48 | +To make a successful contribution, please follow these steps: |
| 49 | + |
| 50 | +1. **Fork the Repository**: Start by forking the repository to your GitHub account. |
| 51 | + |
| 52 | +2. **Make Your Changes**: |
| 53 | + - Implement your changes, ensuring that you match the existing coding style and documentation conventions. |
| 54 | + - Write unit tests for your code to ensure it is functional and reliable. |
| 55 | + |
| 56 | +3. **Write a Clear Commit Message**: Write a concise and informative commit message summarizing your changes. |
| 57 | + |
| 58 | +4. **Push to Your Fork**: Push your changes to your forked repository. |
| 59 | + |
| 60 | +5. **Submit a Pull Request (PR)**: Open a pull request against the main repository. |
| 61 | + |
| 62 | +### Review Process |
| 63 | + |
| 64 | +Our team will review your proposed changes as soon as possible. Since our tools are complex and cover a wide range of |
| 65 | +use cases, we may request additional modifications. This helps ensure that your contribution meets our quality |
| 66 | +standards, is generally applicable, and doesn’t negatively impact other use cases or maintainability. |
| 67 | + |
| 68 | +Thank you for helping us improve this project! We value your effort and commitment. |
0 commit comments