Skip to content

Commit 9fe7298

Browse files
rzrsilabs-akosj
authored andcommitted
.g/CONTRIBUTING.md: Fix mistake and delete trailing space
Origin: #7 Signed-off-by: Philippe Coval <[email protected]>
1 parent b4093d1 commit 9fe7298

File tree

1 file changed

+26
-26
lines changed

1 file changed

+26
-26
lines changed

.github/CONTRIBUTING.md

Lines changed: 26 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,33 @@
11
# Contributing Guideline
2-
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
2+
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
44
the chaos that can result from an active development community.
55

6-
This document explains how to participate in project conversations, log bugs and enhancement requests,
6+
This document explains how to participate in project conversations, log bugs and enhancement requests,
77
and submit patches to the project so your patch will be accepted quickly into the codebase.
88

99
## 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+
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
1212
and have Git tools available on your development system. You also need to add your email address to your account.
1313

1414
As a contributor, you'll want to be familiar with the Silicon Labs tooling:
15-
- [Simplicity Studio](https://docs.silabs.com/simplicity-studio-5-users-guide/latest/ss-5-users-guide-overview/)
16-
- [Platform](https://docs.silabs.com/gecko-platform/latest/platform-overview/)
17-
- [Simplicity Commander](https://docs.silabs.com/simplicity-commander/latest/simplicity-commander-start/)
15+
- [Simplicity Studio](https://docs.silabs.com/simplicity-studio-5-users-guide/latest/ss-5-users-guide-overview/)
16+
- [Platform](https://docs.silabs.com/gecko-platform/latest/platform-overview/)
17+
- [Simplicity Commander](https://docs.silabs.com/simplicity-commander/latest/simplicity-commander-start/)
1818

19-
Read the Silicon Labs [coding guidelines](https://github.com/SiliconLabsSoftware/agreements-and-guidelines/blob/main/coding_standard.md).
19+
Read the Silicon Labs [coding guidelines](https://github.com/SiliconLabsSoftware/agreements-and-guidelines/blob/main/coding_standard.md).
2020
## Git Setup
21-
We need to know who you are, and how to contact you. Please ass the following information to your Git installation:
21+
We need to know who you are, and how to contact you. Please add the following information to your Git installation:
2222
```
2323
git config --global user.name "FirstName LastName"
2424
git config --global user.email "[email protected]"
2525
```
2626
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.
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.
2929

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
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
3131
(user.name & user.email).
3232

3333
### Set up GitHub commit signature
@@ -39,7 +39,7 @@ The repository requires signed off commits. Follow this [guide](https://docs.git
3939
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)
4040
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)
4141

42-
**Command line steps:**
42+
**Command line steps:**
4343
Use the git-bash and navigate into your local repo.
4444
1. disable all the gpg signature globally. (Optional)
4545
```
@@ -80,8 +80,8 @@ Please check the [Licensing.md](../LICENSE.md) for more details.
8080
## Contributor License Agreement
8181
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.
8282

83-
Please check Silicon Labs [CLA document](https://github.com/SiliconLabsSoftware/agreements-and-guidelines/blob/main/contributor_license_agreement.md).
84-
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.
83+
Please check Silicon Labs [CLA document](https://github.com/SiliconLabsSoftware/agreements-and-guidelines/blob/main/contributor_license_agreement.md).
84+
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.
8585
Signatures have a 6-month expiration period.
8686

8787
## Contribution process
@@ -95,7 +95,7 @@ Please follow the official GitHub [guide](https://docs.github.com/en/get-started
9595
You can create your branch on your own forked repo now.
9696

9797
### Branch Naming Convention
98-
Branch naming shall follow the following template: *IssueNumber-issue-title-goes-here*
98+
Branch naming shall follow the following template: *IssueNumber-issue-title-goes-here*
9999
Example branch name:
100100
```
101101
99-bootloader-implementation
@@ -106,7 +106,7 @@ Now you have a branch. You can start committing your code onto it.
106106
## Commit Messages
107107

108108
Silicon Labs repositories require signed-off commits.
109-
Every commit represents a change inside the repository. Every change needs to be documented extensively.
109+
Every commit represents a change inside the repository. Every change needs to be documented extensively.
110110
```
111111
Issuenumber-summary-of-changes
112112
@@ -115,20 +115,20 @@ Another line of really good description
115115
```
116116

117117
## 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**
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**
122122
By default, GitHub uses the branch name as the pull request title. If the branch naming convention was followed, no changes are needed here.
123123
2. **Create Description**
124124
Fill out the pull request template.
125-
3. **Check the Reviewer List**
126-
GitHub assigns reviewers based on the [CODEOWNERS](CODEOWNERS) file.
125+
3. **Check the Reviewer List**
126+
GitHub assigns reviewers based on the [CODEOWNERS](CODEOWNERS) file.
127127
Add more reviewers if needed. Do not remove reviewers from the PR. Ask the repository owner for updates to the code owners.
128-
4. **Evaluate the Action Workflow Results**
128+
4. **Evaluate the Action Workflow Results**
129129
The following workflows are included in every repository:
130130
- **[Coding Convention Check](workflows/00-Check-Code-Convention.yml)**: Analyzes the code formatting and fails if any rules are broken.
131-
- **[Firmware Build](workflows/02-Build-Firmware.yml)**: Builds the firmware inside the [Dockerfile](../Dockerfile).
131+
- **[Firmware Build](workflows/02-Build-Firmware.yml)**: Builds the firmware inside the [Dockerfile](../Dockerfile).
132132
- **[Secret Scanner](workflows/04-TruffleHog-Security-Scan.yml)**: Runs the TruffleHog security scanner to look for API keys and committed secrets.
133133

134134
### As a Reviewer

0 commit comments

Comments
 (0)