Wiki

Analog Devices Wiki

English
English
简体中文
简体中文
日本語
日本語
Руccкий
Руccкий

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
resources:no-os:drivers-guide [14 Nov 2022 13:59] – Submission Checklist Dragos Bogdanresources:no-os:drivers-guide [18 Nov 2022 14:06] (current) – [Documenting the Code] Ramona Bolboaca
Line 90: Line 90:
 ==== Documenting the Code==== ==== Documenting the Code====
  
-Doxygen comments above each function are required.+  * Doxygen comments above each function are required. 
 +  * Nice to have: If a new driver is added, it is recommended to create a Wiki page with the driver description and reference it here: [[:resources:no-os:drivers]] 
  
 ==== Variables ==== ==== Variables ====
Line 226: Line 228:
 Before being reviewed by the no-OS maintainers and then accepted to the GitHub repository, each commit should respect a few rules: Before being reviewed by the no-OS maintainers and then accepted to the GitHub repository, each commit should respect a few rules:
   * The commit contains a "Signed-off-by" trailer by the committer at the end of the commit log message - it certifies that the committer has the rights to submit the work under the project’s license.   * The commit contains a "Signed-off-by" trailer by the committer at the end of the commit log message - it certifies that the committer has the rights to submit the work under the project’s license.
-  * If built using gcc, options such as -Wall and -Wextra don't detect any issues with the commit.+  * If built using gcc, options such as -Wall and -Wextra don't detect any issues with the commit. When the pull request is created, drivers and project build are automatically triggered.
   * //astyle --style=linux --indent=force-tab=8 --max-code-length=80// doesn't detect any issue with the commit.   * //astyle --style=linux --indent=force-tab=8 --max-code-length=80// doesn't detect any issue with the commit.
 +  * It is advised to provide a detailed description of how the new changes were tested. This information can be written in the pull request description. If the driver was tested on one of the supported No-OS platforms, it is recommended to also add a project example which uses the newly added driver.
  
 ===== Beautifying code ===== ===== Beautifying code =====
resources/no-os/drivers-guide.txt · Last modified: 18 Nov 2022 14:06 by Ramona Bolboaca

Page Tools