Skip to content

Commit 365bf4f

Browse files
Create CONTRIBUTING.md
1 parent e8a72e7 commit 365bf4f

File tree

1 file changed

+46
-0
lines changed

1 file changed

+46
-0
lines changed

CONTRIBUTING.md

+46
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
# Contribution Guide for Open Source Developers
2+
3+
## Introduction
4+
Welcome to a Silicon Labs open source project! We are excited to have you contribute. This guide will help you understand how to get started, the process for contributing, and the rules you need to follow.
5+
6+
## Getting Started
7+
1. **Fork the Repository**: Start by forking the repository to your GitHub account.
8+
[GitHub Forking Documentation](https://docs.github.com/en/get-started/quickstart/fork-a-repo).
9+
10+
1. **Clone the Repository**: Clone the forked repository to your local machine using `git clone`.
11+
[GitHub cloning Documentation](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository)
12+
13+
## Creating an Issue
14+
Before you start working on a new feature or bug fix, you need to create a GitHub issue. This helps us keep track of what is being worked on and ensures that multiple people are not working on the same thing.
15+
16+
1. **Check for Existing Issues**: Before creating a new issue, check if there is already an issue for the same topic.
17+
2.
18+
3. **Create a New Issue**: If no existing issue is found, create a new issue with a detailed description of the problem or feature request.
19+
20+
## Contributor License Agreement (CLA)
21+
All contributors must sign a Contributor License Agreement (CLA) before their contributions can be accepted. This ensures that the project can legally use the contributions.
22+
CLA signage is covered with an github workflow. You will be asked to give email-address and company name (if it is a business account).
23+
24+
## Making Changes
25+
1. **Create a Branch**: Create a branch based on the issue what you just created.
26+
2. **Make Your Changes**: Make the necessary changes in your local repository.
27+
3. **Commit Your Changes**: Commit your changes with a clear and descriptive commit message using `git commit -m "Description of changes"`.
28+
29+
## Submitting a Pull Request
30+
1. **Push to Your Fork**: Push your changes to your forked repository using `git push origin branch-name`.
31+
2. **Open a Pull Request**: Navigate to the original repository and open a pull request from your forked repository. Ensure that you link the pull request to the relevant issue.
32+
33+
## Code Review
34+
1. **Review Process**: Your pull request will be reviewed by the project maintainers. They may request changes or provide feedback.
35+
2. **Make Requested Changes**: If changes are requested, make the necessary updates and push them to your branch. The pull request will be updated automatically.
36+
37+
## Merging
38+
Once your pull request is approved, it will be merged into the main branch by a project maintainer.
39+
40+
## Additional Guidelines
41+
- **Code of Conduct**: Follow the project's code of conduct to ensure a welcoming and inclusive environment for all contributors.
42+
- **Documentation**: Update the documentation if your changes affect any part of it.
43+
- **Testing**: Ensure that your changes are well-tested and do not break existing functionality.
44+
45+
## Support
46+
If you have any questions or need help, feel free to reach out to the project maintainers or open an issue for support.

0 commit comments

Comments
 (0)