Skip to content

Commit 039b630

Browse files
authored
Merge pull request #19 from SiliconLabsSoftware/fix-contributing-page
Mention the doccurator branches in the PR template and contribution guidelines
2 parents da1a901 + 78f45b4 commit 039b630

File tree

2 files changed

+4
-3
lines changed

2 files changed

+4
-3
lines changed

.github/CONTRIBUTING.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ As a contributor, you'll want to be familiar with the Silicon Labs tooling:
1818

1919
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]"
@@ -92,7 +92,7 @@ Please follow the official GitHub [guide](https://opensource.guide/how-to-contri
9292
When you created an issue and based on the discussion you want to contribute with your source-code.
9393
Branching is disabled on the public Silicon Labs repositories. You need to fork your own repo first.
9494
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.
95+
You can create your branch on your own forked repo now. Pull requests must be merged into the doccurator branches corresponding to the Matter release the change applies to (for example, `doccurator/2.6.2`.
9696

9797
### Branch Naming Convention
9898
Branch naming shall follow the following template: *IssueNumber-issue-title-goes-here*
@@ -115,7 +115,7 @@ 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.
118+
Okay you finished your work committed all your changes to your branch. Time to create a pull request. Pull requests must be merged into the doccurator branches corresponding to the Matter release the change applies to (for example, `doccurator/2.6.2`).
119119
Refer to the general pull request [guideline](https://opensource.guide/how-to-contribute/#opening-a-pull-request) from GitHub.
120120
What to consider when raising a Pull Request:
121121
1. **Pull Request Naming**

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
## Description
22
<!-- Provide a brief description of the changes in this pull request. -->
3+
<!-- Note that the pull requests must be merged into the doccurator branches corresponding to the Matter release the change applies to, for example doccurator/2.6.2 . -->
34

45
## Related Issue
56
<!-- If this pull request addresses an issue, link to it here. -->

0 commit comments

Comments
 (0)