|
| 1 | +********************* |
| 2 | +Contributing to no-OS |
| 3 | +********************* |
| 4 | + |
| 5 | +Fork and pull request workflow |
| 6 | +============================== |
| 7 | + |
| 8 | +When you don't have write permissions to the **no-OS** repository, the |
| 9 | +**fork and pull request** workflow can be used. |
| 10 | + |
| 11 | +More details: `GitHub Quickstart: Contributing to projects |
| 12 | +<https://docs.github.com/en/get-started/quickstart/contributing-to-projects>`_. |
| 13 | + |
| 14 | +Once a pull request is opened, select the **analogdevicesinc/noos** team as a |
| 15 | +reviewer. The changes should be approved by at least one no-OS maintainer |
| 16 | +before they can be merged to the base brach. |
| 17 | + |
| 18 | +Submission Checklist |
| 19 | +==================== |
| 20 | + |
| 21 | +Before being reviewed by the no-OS maintainers and then accepted to the GitHub |
| 22 | +repository, each commit should respect a few rules: |
| 23 | + |
| 24 | +- The commit contains a **Signed-off-by** trailer by the committer at the end |
| 25 | + of the commit log message - it certifies that the committer has the rights to |
| 26 | + submit the work under the project's license. |
| 27 | + |
| 28 | +- If built using **gcc**, options such as **-Wall** and **-Wextra** don't |
| 29 | + detect any issues with the commit. When the pull request is created, drivers |
| 30 | + and project build are automatically triggered. |
| 31 | + |
| 32 | +- **astyle --style=linux --indent=force-tab=8 --max-code-length=80** doesn't |
| 33 | + detect any issue with the commit. |
| 34 | + |
| 35 | +- A detailed description of how the new changes were tested is provided. This |
| 36 | + information can be written in the pull request description. If the driver |
| 37 | + was tested on one of the supported no-OS platforms, it is recommended to also |
| 38 | + add a project example which uses the newly added driver. |
0 commit comments