Skip to content

Commit 220e12c

Browse files
sabollim-silabsarun-silabs
sabollim-silabs
authored and
arun-silabs
committed
MATTER AWS Documentation
0 parents  commit 220e12c

File tree

1,677 files changed

+11876
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

1,677 files changed

+11876
-0
lines changed

‎.github/CODEOWNERS‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
# This is a # Default codeowners for the repository
2+
* @SiliconLabsSoftware/techpubs

‎.github/CONTRIBUTING.md‎

Lines changed: 141 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,141 @@
1+
# 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
4+
the chaos that can result from an active development community.
5+
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.
8+
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
12+
and have Git tools available on your development system. You also need to add your email address to your account.
13+
14+
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/)
18+
19+
Read the Silicon Labs [coding guidelines](https://github.com/SiliconLabsSoftware/agreements-and-guidelines/blob/main/coding_standard.md).
20+
## Git Setup
21+
We need to know who you are, and how to contact you. Please add the following information to your Git installation:
22+
```
23+
git config --global user.name "FirstName LastName"
24+
git config --global user.email "[email protected]"
25+
```
26+
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+
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+
33+
### Set up GitHub commit signature
34+
35+
**command line setup**
36+
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)
41+
42+
**Command line steps:**
43+
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+
```
52+
3. Configure the local repo with your new key.
53+
```
54+
$ gpg --list-secret-keys --keyid-format=long
55+
gpg: checking the trustdb
56+
gpg: marginals needed: 3 completes needed: 1 trust model: pgp
57+
gpg: depth: 0 valid: 1 signed: 0 trust: 0-, 0q, 0n, 0m, 0f, 1u
58+
/c/Users/silabsuser/.gnupg/pubring.kbx
59+
------------------------------------
60+
sec rsa3072/1234567891234567 2025-04-09 [SC]
61+
ABDGDGFDGFDGDHHSRGRG12345667912345678981
62+
uid [ultimate] Firstname Lastname <[email protected]>
63+
ssb rsa3072/11098765432110981 2025-04-09 [E]
64+
65+
$ git config user.signingkey 1234567891234567
66+
```
67+
4. Force every commit to be signed
68+
```
69+
$ git config commit.gpgsign true
70+
```
71+
5. Export your gpg key
72+
```
73+
$ gpg --armor --export 888BA795B7085898
74+
```
75+
Make sure your email address is verified by GitHub before committing anything.
76+
77+
## Licensing
78+
Please check the [Licensing.md](../LICENSE.md) for more details.
79+
80+
## 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.
82+
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.
85+
Signatures have a 6-month expiration period.
86+
87+
## Contribution process
88+
### Creating an Issue
89+
Please follow the official GitHub [guide](https://opensource.guide/how-to-contribute/#opening-an-issue).
90+
91+
### 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. Pull requests must be merged into the doccurator branches corresponding to the Matter release the change applies to (for example, `doccurator/2.6.2`.
96+
97+
### Branch Naming Convention
98+
Branch naming shall follow the following template: *IssueNumber-issue-title-goes-here*
99+
Example branch name:
100+
```
101+
99-bootloader-implementation
102+
```
103+
Issue number is necessary to maintain tracebility.
104+
Now you have a branch. You can start committing your code onto it.
105+
106+
## Commit Messages
107+
108+
Silicon Labs repositories require signed-off commits.
109+
Every commit represents a change inside the repository. Every change needs to be documented extensively.
110+
```
111+
Issuenumber-summary-of-changes
112+
113+
Detailed description what was implemented.
114+
Another line of really good description
115+
```
116+
117+
## Pull Request Guideline
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`).
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**
122+
By default, GitHub uses the branch name as the pull request title. If the branch naming convention was followed, no changes are needed here.
123+
2. **Create Description**
124+
Fill out the pull request template.
125+
3. **Check the Reviewer List**
126+
GitHub assigns reviewers based on the [CODEOWNERS](CODEOWNERS) file.
127+
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**
129+
The following workflows are included in every repository:
130+
- **[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).
132+
- **[Secret Scanner](workflows/04-TruffleHog-Security-Scan.yml)**: Runs the TruffleHog security scanner to look for API keys and committed secrets.
133+
134+
### As a Reviewer
135+
136+
What to consider when reviewing a Pull Request:
137+
138+
- All builds must pass successfully.
139+
- The code must follow the Silicon Labs [coding guidelines](https://github.com/SiliconLabsSoftware/agreements-and-guidelines/blob/main/coding_standard.md).
140+
- Write clear comments. Describe the issue and explain why you disagree (e.g., mistakes, errors, violations of conventions, performance risks, security issues, etc.).
141+
- If any comments must be addressed mandatorily, mark the pull request as “Draft.”

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
title: 'Bug: '
5+
labels: bug
6+
assignees: ''
7+
8+
---
9+
10+
**Describe the bug**
11+
A clear and concise description of what the bug is.
12+
13+
**To Reproduce**
14+
Steps to reproduce the behavior:
15+
1. Go to '...'
16+
2. Click on '....'
17+
3. Scroll down to '....'
18+
4. See error
19+
20+
**Expected behavior**
21+
A clear and concise description of what you expected to happen.
22+
23+
**Screenshots**
24+
If applicable, add screenshots to help explain your problem.
25+
26+
**Additional context**
27+
Add any other context about the problem here.

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
title: 'Feature: '
5+
labels: enhancement
6+
assignees: ''
7+
8+
---
9+
10+
**Is your feature request related to a problem? Please describe.**
11+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
12+
13+
**Describe the solution you'd like**
14+
A clear and concise description of what you want to happen.
15+
16+
**Describe alternatives you've considered**
17+
A clear and concise description of any alternative solutions or features you've considered.
18+
19+
**Additional context**
20+
Add any other context or screenshots about the feature request here.

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
## Description
2+
<!-- 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 . -->
4+
5+
## Related Issue
6+
<!-- If this pull request addresses an issue, link to it here. -->
7+
Closes #<issue_number>
8+
9+
## Changes Made
10+
<!-- List the changes made in this pull request. -->
11+
-
12+
13+
## Checklist
14+
- [ ] I have read the [Contributor License Agreement](https://github.com/SiliconLabsSoftware/agreements-and-guidelines/blob/main/contributor_license_agreement.md).
15+
- [ ] I have followed the repository's [coding guidelines](https://github.com/SiliconLabsSoftware/agreements-and-guidelines/blob/main/coding_standard.md) .
16+
- [ ] I have checked the action workflow results and they are all passed.
17+
18+
## Screenshots (if applicable)
19+
<!-- Add screenshots to help explain the changes (if applicable). -->
20+
21+
## Additional Notes
22+
<!-- Add any additional information or context. -->

‎.github/coding-convention-tool‎

Submodule coding-convention-tool added at bb792db

‎.github/workflows/01-CLA-Assistant.yml‎

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
name: CLA validation
2+
3+
on:
4+
issue_comment:
5+
types: [created]
6+
pull_request_target:
7+
types: [opened, synchronize, reopened]
8+
9+
permissions:
10+
actions: write
11+
contents: read
12+
pull-requests: write
13+
statuses: write
14+
15+
jobs:
16+
CLAAssistant:
17+
runs-on: ubuntu-latest
18+
steps:
19+
- name: Create CLA Assistant Lite bot token
20+
uses: actions/create-github-app-token@v2
21+
id: app-token
22+
with:
23+
app-id: ${{ secrets.SILABSIN_CLA_BOT_APP_ID }}
24+
private-key: ${{ secrets.SILABSIN_CLA_BOT_APP_PRIVATE_KEY }}
25+
owner: SiliconLabsInternal
26+
repositories: contributor-license-agreements
27+
28+
- name: Mask generated token
29+
run: echo "::add-mask::${{ steps.app-token.outputs.token }}"
30+
31+
- name: "CLA Assistant"
32+
if: ${{ contains(github.event.comment.body, 'I have read the CLA Document and I hereby sign the CLA') }} || github.event_name == 'pull_request_target'
33+
uses: SiliconLabsSoftware/action-cla-assistant@silabs_flavour_v2
34+
env:
35+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
36+
PERSONAL_ACCESS_TOKEN: ${{ steps.app-token.outputs.token }}
37+
with:
38+
path-to-signatures: "cla_signatures_db.json"
39+
path-to-document: "https://github.com/SiliconLabsSoftware/agreements-and-guidelines/blob/main/contributor_license_agreement.md"
40+
branch: 'cla-database'
41+
allowlist: silabs-*,bot*
42+
# the following are the optional inputs - If the optional inputs are not given, then default values will be taken
43+
remote-organization-name: "SiliconLabsInternal"
44+
remote-repository-name: "contributor-license-agreements"
45+
create-file-commit-message: "Created the CLA database file. CLA Assistant Lite bot created this file."
46+
signed-commit-message: "$contributorName has signed the CLA in $owner/$repo#$pullRequestNo"

‎.github/workflows/04-TruffleHog-Security-Scan.yml‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
name: 04-TruffleHog-Security-Scan
2+
on:
3+
pull_request:
4+
branches:
5+
- main
6+
- master
7+
- develop
8+
- "release/**"
9+
jobs:
10+
trufflehog_scan:
11+
runs-on: ubuntu-24.04
12+
steps:
13+
- name: Checkout code
14+
uses: actions/checkout@v4
15+
with:
16+
fetch-depth: 0
17+
- name: Secret Scanning
18+
uses: trufflesecurity/[email protected]
19+
with:
20+
extra_args: --only-verified

‎.gitignore‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# General part of the gitignore
2+
*.launch
3+
*.orig
4+
*.bak
5+
.vscode/
6+
**/build/
7+
**/GNU ARM v*
8+
**/.projectlinkstore
9+
**/.settings
10+
**/.makefile
11+
**/.trash
12+
**/.uceditor
13+
**/autogen/*.crc
14+
**/__pycache__
15+
**/GNU ARM v*
16+
**/IAR ARM*
17+
**/sonar-bw/
18+
19+
#Enable these if you are not tracking Simplicity studio project
20+
**/.cproject
21+
**/.project
22+
**/.pdm

‎.gitmodules‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
[submodule ".github/coding-convention-tool"]
2+
path = .github/coding-convention-tool
3+
url = https://github.com/SiliconLabsSoftware/coding-convention-tool.git

0 commit comments

Comments
 (0)