You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
As an open-source project, we welcome and encourage the community to submit patches directly to the project.
3
-
In our collaborative open-source environment, standards and methods for submitting changes help reduce
4
-
the chaos that can result from an active development community.
5
2
6
-
This document explains how to participate in project conversations, log bugs and enhancement requests,
7
-
and submit patches to the project so your patch will be accepted quickly into the codebase.
3
+
As an open-source project, we welcome and encourage the community to submit patches directly to the project.
4
+
5
+
In our collaborative open-source environment, standards and methods for submitting changes help us to maintain the data structure and integrity.
6
+
7
+
This document explains how to participate in project discussions, report bugs and enhancement requests, and submit patches so that your contributions can be quickly accepted into the codebase.
8
8
9
9
## Prerequisites
10
-
You should be familiar with Git and GitHub. [Getting started](https://docs.github.com/en/get-started)
11
-
If you haven't already done so, you'll need to create a (free) GitHub account at https://github.com
10
+
11
+
You should be familiar with Git and GitHub. [Getting started](https://docs.github.com/en/get-started)
12
+
If you have not already done so, you will need to create a (free) GitHub account at [GitHub](https://github.com)
12
13
and have Git tools available on your development system. You also need to add your email address to your account.
13
14
14
-
As a contributor, you'll want to be familiar with the Silicon Labs tooling:
15
+
As a contributor, you will want to be familiar with the Silicon Labs tooling:
set the Git configuration variables user.name to your full name, and user.email to your email address.
27
-
The user.name must be your full name (first and last at minimum), not a pseudonym or hacker handle.
28
-
The email address that you use in your Git configuration must match the email address you use to sign your commits.
29
31
30
-
If you intend to edit commits using the Github.com UI, ensure that your github profile email address and profile name also match those used in your git configuration
31
-
(user.name & user.email).
32
+
Set the Git configuration variables user.name to your full name and user.email to your email address. Your user.name must be your full name (at least first and last name), not a pseudonym or handle. The email address you specify in your Git configuration must match the email address you use to sign your commits.
33
+
34
+
If you intend to edit commits using the GitHub.com UI, ensure that your GitHub profile name and email address also match those used in your Git configuration (user.name and user.email).
32
35
33
36
### Set up GitHub commit signature
34
37
35
-
**command line setup**
38
+
**Command line setup:**
39
+
40
+
The repository requires signed-off commits. Follow this [guide](https://docs.github.com/en/authentication/managing-commit-signature-verification/signing-commits) how to set it up.
36
41
37
-
The repository requires signed off commits. Follow this [guide](https://docs.github.com/en/authentication/managing-commit-signature-verification/signing-commits) how to set it up.
38
-
1. Generate a gpg key [howto](https://docs.github.com/en/authentication/managing-commit-signature-verification/generating-a-new-gpg-key)
39
-
2. Configure your local repository with the gpg key. [guide]whttps://docs.github.com/en/authentication/managing-commit-signature-verification/telling-git-about-your-signing-key)
40
-
3. Configure your GitHub account with the gpg key [guide](https://docs.github.com/en/authentication/managing-commit-signature-verification/associating-an-email-with-your-gpg-key)
42
+
1. Generate a GPG key. For further info, follow [this](https://docs.github.com/en/authentication/managing-commit-signature-verification/generating-a-new-gpg-key) link.
43
+
2. Configure your local repository with the gpg key [guide](https://docs.github.com/en/authentication/managing-commit-signature-verification/telling-git-about-your-signing-key).
44
+
3. Configure your GitHub account with the gpg key [guide](https://docs.github.com/en/authentication/managing-commit-signature-verification/associating-an-email-with-your-gpg-key).
45
+
46
+
**Command line steps:**
41
47
42
-
**Command line steps:**
43
48
Use the git-bash and navigate into your local repo.
44
-
1. disable all the gpg signature globally. (Optional)
45
-
```
46
-
$ git config --global --unset gpg.format
47
-
```
48
-
2. Create a gpg-key
49
-
```
50
-
$ gpg --full-generate-key
51
-
```
49
+
50
+
1. Disable all the GPG signature globally. (Optional)
Make sure your email address is verified by GitHub before committing anything.
76
92
77
93
## Licensing
78
-
Please check the [Licensing.md](../LICENSE.md) for more details.
94
+
95
+
For more information about licensing, please check this [LICENSE.md](../LICENSE.md) document.
79
96
80
97
## Contributor License Agreement
81
-
When a project receives a contribution, it must be clear that the contributor has the rights to contribute the content and that the project then has the rights to use and otherwise operate with the content (e.g., relicense or distribute). A Contributor License Agreement (CLA) is a legal document establishing these rights and defining the terms under which a license is granted by a contributor to an open-source project. A CLA clarifies that any contribution was authorized (not contributing someone else’s code without permission or without legal authority to contribute) and protects the project from potential future legal challenges.
During the pull request review, every new contributor must sign the CLA document. It can be signed as an individual or on behalf of a company.
85
-
Signatures have a 6-month expiration period.
99
+
When a project receives a contribution, it must be clear that the contributor has the rights to contribute the content, and that the project has the rights to use, Re-license, or distribute the content. A Contributor License Agreement (CLA) is a legal document that establishes these rights and defines the terms under which a contributor grants a license to an open-source project. The CLA ensures that all contributions are authorized (i.e., not contributed without permission or legal authority) and protects the project from potential future legal challenges.
During the pull request review process, every new contributor must sign the CLA. The CLA may be signed as an individual or on behalf of a company. Signatures are valid for a period of six months.
86
103
87
104
## Contribution process
105
+
88
106
### Creating an Issue
107
+
89
108
Please follow the official GitHub [guide](https://opensource.guide/how-to-contribute/#opening-an-issue).
90
109
91
110
### Fork the repository
92
-
When you created an issue and based on the discussion you want to contribute with your source-code.
93
-
Branching is disabled on the public Silicon Labs repositories. You need to fork your own repo first.
94
-
Please follow the official GitHub [guide](https://docs.github.com/en/get-started/exploring-projects-on-github/contributing-to-a-project).
95
-
You can create your branch on your own forked repo now.
111
+
112
+
When you create an issue and, based on the discussion, decide to contribute your source code, please note that branching is disabled on public Silicon Labs repositories. You will need to fork the repository to your own account first. Follow the official GitHub [guide](https://docs.github.com/en/get-started/exploring-projects-on-github/contributing-to-a-project) for instructions. Once you have forked the repository, you can create a branch in your forked repo.
96
113
97
114
### Branch Naming Convention
98
-
Branch naming shall follow the following template: *IssueNumber-issue-title-goes-here*
115
+
116
+
Branch naming shall follow the following template: *IssueNumber-issue-title-goes-here*
99
117
Example branch name:
100
-
```
118
+
119
+
```bash
101
120
99-bootloader-implementation
102
121
```
103
-
Issue number is necessary to maintain tracebility.
104
-
Now you have a branch. You can start committing your code onto it.
122
+
123
+
Issue number is necessary to maintain traceability.
124
+
Now that you have a branch, you can start committing your code to it.
Every commit represents a change inside the repository. Every change needs to be documented extensively.
110
-
```
111
-
Issuenumber-summary-of-changes
129
+
Every commit represents a change inside the repository. Every change needs to be documented extensively.
130
+
131
+
```bash
132
+
Issue-number-summary-of-changes
112
133
113
-
Detailed description what was implemented.
114
-
Another line of really good description
134
+
A detailed description of what was implemented should be provided.
135
+
136
+
Another line of really good description.
115
137
```
116
138
117
139
## Pull Request Guideline
118
-
Okay you finished your work committed all your changes to your branch. Time to create a pull request.
119
-
Refer to the general pull request [guideline](https://opensource.guide/how-to-contribute/#opening-a-pull-request) from GitHub.
120
-
What to consider when raising a Pull Request:
121
-
1.**Pull Request Naming**
140
+
141
+
Okay, you finished your work and committed all your changes to your branch. Time to create a pull request.
142
+
Refer to the general pull request [guideline](https://opensource.guide/how-to-contribute/#opening-a-pull-request) from GitHub.
143
+
144
+
What to consider when raising a Pull Request:
145
+
146
+
1.**Pull Request Naming**
147
+
122
148
By default, GitHub uses the branch name as the pull request title. If the branch naming convention was followed, no changes are needed here.
149
+
123
150
2.**Create Description**
151
+
124
152
Fill out the pull request template.
125
-
3.**Check the Reviewer List**
126
-
GitHub assigns reviewers based on the [CODEOWNERS](CODEOWNERS) file.
153
+
154
+
3.**Check the Reviewer List**
155
+
156
+
GitHub assigns reviewers based on the [CODEOWNERS](CODEOWNERS) file.
127
157
Add more reviewers if needed. Do not remove reviewers from the PR. Ask the repository owner for updates to the code owners.
128
158
129
159
### As a Reviewer
@@ -133,4 +163,4 @@ What to consider when reviewing a Pull Request:
133
163
- All builds must pass successfully.
134
164
- The code must follow the Silicon Labs [coding guidelines](https://github.com/SiliconLabsSoftware/agreements-and-guidelines/blob/main/coding_standard.md).
135
165
- Write clear comments. Describe the issue and explain why you disagree (e.g., mistakes, errors, violations of conventions, performance risks, security issues, etc.).
136
-
- If any comments must be addressed mandatorily, mark the pull request as “Draft.”
166
+
- If any comments must be addressed before merging, mark the pull request as “Draft”.
0 commit comments