Skip to content

Mention the doccurator branches in the PR template and contribution guidelines #19

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Sep 16, 2025
Merged

Mention the doccurator branches in the PR template and contribution guidelines #19

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
dd8d10a
Mention the doccurator branches
selissia Aug 22, 2025
66d407e
Mention the doccurator branches in the PR template
selissia Aug 22, 2025
0e440ce
Update CONTRIBUTING.md
silabs-vm Sep 16, 2025
78f45b4
Update CONTRIBUTING.md
silabs-vm Sep 16, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions .github/CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ As a contributor, you'll want to be familiar with the Silicon Labs tooling:

Read the Silicon Labs [coding guidelines](https://github.com/SiliconLabsSoftware/agreements-and-guidelines/blob/main/coding_standard.md).
## Git Setup
We need to know who you are, and how to contact you. Please ass the following information to your Git installation:
We need to know who you are, and how to contact you. Please add the following information to your Git installation:
```
git config --global user.name "FirstName LastName"
git config --global user.email "firstname.lastname@example.com"
Expand Down Expand Up @@ -92,7 +92,7 @@ Please follow the official GitHub [guide](https://opensource.guide/how-to-contri
When you created an issue and based on the discussion you want to contribute with your source-code.
Branching is disabled on the public Silicon Labs repositories. You need to fork your own repo first.
Please follow the official GitHub [guide](https://docs.github.com/en/get-started/exploring-projects-on-github/contributing-to-a-project).
You can create your branch on your own forked repo now.
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`.

### Branch Naming Convention
Branch naming shall follow the following template: *IssueNumber-issue-title-goes-here*
Expand All @@ -115,7 +115,7 @@ Another line of really good description
```

## Pull Request Guideline
Okay you finished your work committed all your changes to your branch. Time to create a pull request.
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`).
Refer to the general pull request [guideline](https://opensource.guide/how-to-contribute/#opening-a-pull-request) from GitHub.
What to consider when raising a Pull Request:
1. **Pull Request Naming**
Expand Down
1 change: 1 addition & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
## Description
<!-- Provide a brief description of the changes in this pull request. -->
<!-- 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 . -->

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