Skip to content

Commit bf75e13

Browse files
authored
Added contribution guidelines (#834)
* Added contribution guidelines
1 parent e69954d commit bf75e13

1 file changed

Lines changed: 65 additions & 1 deletion

File tree

CONTRIBUTING.md

Lines changed: 65 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,65 @@
1-
# Contributing to this extension
1+
# Contribution Guide
2+
3+
Thank you for your interest in contributing to our project.
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/vscode-cmsis-debugger/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/vscode-cmsis-debugger/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/vscode-cmsis-debugger/issues)
22+
to report misbehavior (i.e. bugs).
23+
24+
Issues are your best way to interact directly with the development team and the community.
25+
We encourage you to add implementation suggestions, as this enables the community to collaboratively shape the solutions needed.
26+
27+
We shall be monitoring and responding to issues as best we can.
28+
Please attempt to avoid filing duplicates of open or closed items when possible.
29+
We use labels to classify and filter issues. See the [available set of labels](https://github.com/Open-CMSIS-Pack/vscode-cmsis-debugger/labels).
30+
31+
### Open a Pull Request
32+
33+
We encourage contributions of all sizes, but please keep each contribution focused and independent. We prefer smaller,
34+
more manageable pull requests, which makes it easier for us to review, provide feedback, and merge changes quickly.
35+
36+
You can submit a pull request at our [GitHub Pull Requests page](https://github.com/Open-CMSIS-Pack/vscode-cmsis-debugger/pulls).
37+
38+
#### Contribution Process
39+
40+
To make a successful contribution, please follow these steps:
41+
42+
1. **Fork the Repository**: Start by forking the repository to your GitHub account.
43+
44+
2. **Make Your Changes**:
45+
- Implement your changes, ensuring that you match the existing coding style and documentation conventions.
46+
- Write unit tests for your code to ensure it is functional and reliable.
47+
- If the code in the file is completely generated by AI, please add a minimal transparency comment at the beginning of the file:
48+
49+
```typescript
50+
// generated with AI
51+
```
52+
53+
3. **Write a Clear Commit Message**: Write a concise and informative commit message summarizing your changes.
54+
55+
4. **Push to Your Fork**: Push your changes to your forked repository.
56+
57+
5. **Submit a Pull Request (PR)**: Open a pull request against the main repository.
58+
59+
### Review Process
60+
61+
Our team will review your proposed changes as soon as possible and provide feedback.
62+
63+
📝 **Note**: *Contributors may use AI-assisted tools when creating code. All contributions must be reviewed and must comply with the projects license and contribution standards.*
64+
65+
Thank you for helping us improve this project! We value your effort and commitment.

0 commit comments

Comments
 (0)