Contributors Guide
The Secure Device Onboard projects welcomes all contributions. Prospective contributors are encouraged to read the project Code of Conduct and Contributors Guide
License and Copyrights¶
Contributions must be submitted under the Apache License 2.0. Include the Apache License header or SPDX header in every source file you contribute. See the following for specific guidance:
...
Note that when subsequent contributors make substantive changes to a file, they may also optionally add a copyright notice for themselves (person or corporation), but should preserve unmodified any existing copyright notices.
Code Contributions¶
If you are contemplating a proposing a major contribution to the Secure Device Onboard project, please first submit an issue outlining your proposed changes or contribution, or contact the development community via Slack or mailing list. This will allow the community to provide feedback on the proposal and ensure that your proposal is in alignment with project goals and processes.
...
- Do not change the architecture in any way
- Do not require the addition, removal, or reorganization of any project repository
- Affect only a single or limited number of repositories
Code Style
...
¶
The Secure Device Onboard project has adopted Google Style Guide for Java for all code implemented in the Java programming language. Note that Java code style is enforced by build verification test run at the time pull requests are submitted using the checkstyle tool. Pull requests that do not pass the style check will not be approved for merge.
The Secure Device Onboard project has adopted the Linux Kernel Style (with a few exceptions) for the Client SDK. Check with a client SDk developer if you have questions about style in this component.
...
...
Commit Process¶
This is the recommended process for submitting pull requests:
...
Note: Your pull request should be rebased against the current master branch. Do not merge the current master branch in with your topic branch. Do not use the Update Branch button provided by GitHub on the pull request page.
Commit Message¶
Include a commit message. Commit messages should follow common Git conventions, such as using the imperative mood, separate subject lines, and a line length of 72 characters. These guidelines and more are documented here: https://chris.beams.io/posts/git-commit/#seven-rules¶
Signed-off-by¶
Each commit must include a “Signed-off-by” line in the commit message (git commit -s). This sign-off indicates that you agree the commit satisfies the Developer Certificate of Origin (DCO).
Commit Email Address¶
Your commit email address must match your GitHub email address. For more information, see https://help.github.com/articles/setting-your-commit-email-address-in-git/
Merge Requirements¶
A pull request will not be merged until it has passed these status checks:
- The build must pass all automated tests executed by the Jenkins build server.
- The pull request must be approved by at least two reviewers without any outstanding requests for changes
Reporting Issues¶
Report issues using each component's respective github repository.