diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..9434f62 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,18 @@ +## Fixes + + +- + +## Changes + + +- + +## Checklist + + +- [ ] πŸ€– This change is covered by unit tests as required. +- [ ] 🀹 All required manual testing has been performed. +- [ ] πŸ›‘οΈ Security impacts have been considered. +- [ ] πŸ“– All documentation updates are complete. +- [ ] 🧠 This change does not change third-party dependencies diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..950f6ad --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,68 @@ +# Contribution Guide + +Thank you for your interest in contributing to our project! We strive to maintain a welcoming and inclusive community. + +## Ways to Contribute + +There are multiple ways you can contribute to this project: + +1. **Report an Issue**: If you encounter a bug or have a suggestion, please open an issue on our +[GitHub Issues page](https://github.com/Open-CMSIS-Pack/cmsis-toolbox/issues) to start the discussion about your proposal. + +2. **Open a Pull Request**: Contributions are welcome, whether you're fixing a bug, adding a new feature, or improving +documentation. You can submit a pull request to our +[GitHub repository](https://github.com/Open-CMSIS-Pack/cmsis-toolbox/pulls) to: + - Provide a bug fix + - Add new features or enhancements + - Improve or expand existing documentation + +### Report an Issue + +Please feel free to raise an [issue on GitHub](https://github.com/Open-CMSIS-Pack/cmsis-toolbox/issues) +to report misbehavior (i.e. bugs) + +Issues are your best way to interact directly with the maintenance team and the community. +We encourage you to append implementation suggestions as this helps to decrease the +workload of the very limited maintenance team. + +We shall be monitoring and responding to issues as best we can. +Please attempt to avoid filing duplicates of open or closed items when possible. +In the spirit of openness we shall be tagging issues with the following: + +- **bug** – This issue is identified as a bug and will be investigated. +- **discussion** – This issue is currently under discussion. +- **discussion done** – The discussion on this issue is complete. +- **documentation** – This issue highlights a documentation gap, which will be addressed in future updates. +- **duplicate** – This issue duplicates an existing one; see comments for related references. +- **enhancement** – This issue represents a request for a new feature or improvement. +- **question** – We need further information or clarification on this issue; please review and respond. +- **wontfix** – While we appreciate this suggestion, we have decided not to make changes at this time. + +### Open a Pull Request + +We encourage contributions of all sizes, but please keep each contribution focused and independent. We prefer smaller, +more manageable pull requests, which makes it easier for us to review, provide feedback, and merge changes quickly. + +#### Contribution Process + +To make a successful contribution, please follow these steps: + +1. **Fork the Repository**: Start by forking the repository to your GitHub account. + +2. **Make Your Changes**: + - Implement your changes, ensuring that you match the existing coding style and documentation conventions. + - Write unit tests for your code to ensure it is functional and reliable. + +3. **Write a Clear Commit Message**: Write a concise and informative commit message summarizing your changes. + +4. **Push to Your Fork**: Push your changes to your forked repository. + +5. **Submit a Pull Request (PR)**: Open a pull request against the main repository. + +### Review Process + +Our team will review your proposed changes as soon as possible. Since our tools are complex and cover a wide range of +use cases, we may request additional modifications. This helps ensure that your contribution meets our quality +standards, is generally applicable, and doesn’t negatively impact other use cases or maintainability. + +Thank you for helping us improve this project! We value your effort and commitment.