The Sidewalk repository in general follows the Zephyr RTOS Contribution Guidelines
This documents presents an overview of Zephyr Contribution Guidelines and differences specific for this repo:
- The Sidewalk repository uses the nRF Connect SDK Nordic License.
- There are some imported or reused components that use other licensing and are clearly identified. Some of them use the proprietary Amazon Sidewalk Program license. The full text of Amazon License is provided in LICENSE_AMAZON.
- The Sidewalk development is supported on Linux with GNU Arm Embedded Toolchain.
- It is advised to use Visual Studio Code IDE with the nRF Connect Extension Pack.
- The repository follow the Forking Workflow. Instead of using a single server-side repository to act as the “central” codebase, it gives every developer their own server-side repository. This means that each contributor has not one, but two Git repositories: a private local one and a public server-side one. You can read more about GitHub Forking Workflow contribution in Quick Start Tutorial.
- All changes on the main repository branch should be added with pull request. It is required to have at least one review approval to merge, and pass all related CI tests.
- Changes should be added with fast-forward rebase.
- Issue and feature tracking is done in the Nordic Sidewalk Team internal Jira.
- TODO: A Continuous Integration (CI) system runs on every pull request to verify several aspects of the PR including Git commit formatting, Coding Style, sanity checks builds, and documentation builds.