Skip to content

Commit bb7f1d4

Browse files
Added Contribution guidelines doc
1 parent 45b4126 commit bb7f1d4

File tree

2 files changed

+68
-47
lines changed

2 files changed

+68
-47
lines changed

CONTRIBUTING.md

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
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.

README.md

Lines changed: 0 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -455,50 +455,3 @@ configuration.
455455
## License
456456
457457
Open-CMSIS-Pack is licensed under Apache 2.0.
458-
459-
## Contributions and Pull Requests
460-
461-
Contributions are accepted under Apache 2.0. Only submit contributions where you have authored all of the code.
462-
463-
### Proposals, Reviews and Project
464-
465-
Please feel free to raise an [issue on GitHub](https://github.com/Open-CMSIS-Pack/Open-CMSIS-Pack/issues)
466-
to start the discussion about your proposal.
467-
468-
We are in the early days and discuss proposals which we are dividing into 5 work streams with a dedicated label:
469-
470-
- **Core Library Components** - common libraries that are re-used across a range of tools. The PoC Tools are the first
471-
consumers, but the library components can also be used to create commercial derivatives or in-house tooling.
472-
- **Overall Project Concept** - procedures to generate packs and application software. We shall consider complex
473-
applications such as multi-core processor systems or secure/non-secure partitions.
474-
- **PoC Tools** - command line tools and utilities that implement the overall concepts and are intended to be used for
475-
open-source projects or even integrated into commercial software tools.
476-
- **Process Improvements** - documentation and tools that help the software community to streamline and secure the
477-
software delivery to the user base.
478-
- **Resource Management** - describes the data models used to manage and organized software packs and application
479-
projects.
480-
481-
These Issues are tracked inside the [project board](https://github.com/Open-CMSIS-Pack/Open-CMSIS-Pack/projects/1)
482-
483-
### Issues, Labels
484-
485-
Please feel free to raise an [issue on GitHub](https://github.com/Open-CMSIS-Pack/Open-CMSIS-Pack/issues)
486-
to report misbehavior (i.e. bugs)
487-
488-
Issues are your best way to interact directly with the maintenance team and the community.
489-
We encourage you to append implementation suggestions as this helps to decrease the
490-
workload of the very limited maintenance team.
491-
492-
We shall be monitoring and responding to issues as best we can.
493-
Please attempt to avoid filing duplicates of open or closed items when possible.
494-
In the spirit of openness we shall be tagging issues with the following:
495-
496-
- **bug** – We consider this issue to be a bug that shall be investigated.
497-
- **wontfix** - We appreciate this issue but decided not to change the current behavior.
498-
- **out-of-scope** - We consider this issue loosely related to CMSIS. It might be implemented outside of CMSIS. Let us
499-
know about your work.
500-
- **question** – We have further questions about this issue. Please review and provide feedback.
501-
- **documentation** - This issue is a documentation flaw that shall be improved in the future.
502-
- **DONE** - We consider this issue as resolved - please review and close it. In case of no further activity, these
503-
issues shall be closed after a week.
504-
- **duplicate** - This issue is already addressed elsewhere, see a comment with provided references.

0 commit comments

Comments
 (0)