Mirrors_Framework/nuttx
1
0
Fork 0
mirror of https://github.com/apache/nuttx.git synced 2026-09-27 18:58:27 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs: Fix typos, formatting, and numbering in README.md and CONTRIBUTING.md.
Build Documentation / build-html (push) Has been cancelled

Browse Source 
Fix multiple documentation issues in README.md and CONTRIBUTING.md:
* README.md: Merge multi-line badge markdown into single lines for
  License and Contributors badges to follow standard markdown format.
* CONTRIBUTING.md: Remove extra space in Inviolable Principles link URL.
* CONTRIBUTING.md: Fix duplicate numbering in section 1.17 Merge rules
  (two items numbered 3, renumbered to 3, 4, 5).
* CONTRIBUTING.md: Fix typo in section 2.2 commit template example,
  "different thing" to "different things" (missing plural).

Signed-off-by: aiduxiaoxiong <aiduxiaoxiong@users.noreply.github.com>
This commit is contained in:
muyangren
2026-03-23 12:05:24 +01:00
committed by simbit18
parent e3eeaefd6d
commit eea9d15b41
2 changed files with 6 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files
CONTRIBUTING.md
+4 -4
View File
@@ -3,7 +3,7 @@
Thank you for your interest in contributing to Apache NuttX RTOS :-) Thank you for your interest in contributing to Apache NuttX RTOS :-)
If you haven't yet read If you haven't yet read
[The Inviolable Principles of NuttX]( https://github.com/apache/nuttx/blob/master/INVIOLABLES.md) [The Inviolable Principles of NuttX](https://github.com/apache/nuttx/blob/master/INVIOLABLES.md)
please do so first. please do so first.
Apache NuttX RTOS supports over 15 different architectures, 360+ boards, Apache NuttX RTOS supports over 15 different architectures, 360+ boards,
@@ -355,8 +355,8 @@ See: https://github.com/apache/nuttx/blob/master/INVIOLABLES.md
2. Single company / organization commit, review, and merge is not allowed. 2. Single company / organization commit, review, and merge is not allowed.
3. Merge of PRs with unresolved discussions and "change request" marks 3. Merge of PRs with unresolved discussions and "change request" marks
is not allowed. is not allowed.
3. Self committed code merge with or without review is not allowed. 4. Self committed code merge with or without review is not allowed.
4. Direct push to master is not allowed. 5. Direct push to master is not allowed.
Breaking these rules will be punished. Breaking these rules will be punished.
@@ -395,7 +395,7 @@ Add g_ prefix to can_dlc_to_len and len_to_can_dlc to
follow NuttX coding style conventions for global symbols, follow NuttX coding style conventions for global symbols,
improving code readability and maintainability. improving code readability and maintainability.
* you can also use bullet points. * you can also use bullet points.
* to note different thing briefly. * to note different things briefly.
Signed-off-by: AuthorName <Valid@EmailAddress> Signed-off-by: AuthorName <Valid@EmailAddress>
``` ```
README.md
+2 -4
View File
@@ -3,11 +3,9 @@
</p> </p>
![POSIX Badge](https://img.shields.io/badge/POSIX-Compliant-brightgreen?style=flat&label=POSIX) ![POSIX Badge](https://img.shields.io/badge/POSIX-Compliant-brightgreen?style=flat&label=POSIX)
[![License](https://img.shields.io/badge/License-Apache%202.0-blue [![License](https://img.shields.io/badge/License-Apache%202.0-blue)](https://nuttx.apache.org/docs/latest/introduction/licensing.html)
)](https://nuttx.apache.org/docs/latest/introduction/licensing.html)
![Issues Tracking Badge](https://img.shields.io/badge/issue_track-github-blue?style=flat&label=Issue%20Tracking) ![Issues Tracking Badge](https://img.shields.io/badge/issue_track-github-blue?style=flat&label=Issue%20Tracking)
[![Contributors](https://img.shields.io/github/contributors/apache/nuttx [![Contributors](https://img.shields.io/github/contributors/apache/nuttx)](https://github.com/apache/nuttx/graphs/contributors)
)](https://github.com/apache/nuttx/graphs/contributors)
[![GitHub Build Badge](https://github.com/apache/nuttx/workflows/Build/badge.svg)](https://github.com/apache/nuttx/actions/workflows/build.yml) [![GitHub Build Badge](https://github.com/apache/nuttx/workflows/Build/badge.svg)](https://github.com/apache/nuttx/actions/workflows/build.yml)
[![Documentation Badge](https://github.com/apache/nuttx/workflows/Build%20Documentation/badge.svg)](https://nuttx.apache.org/docs/latest/index.html) [![Documentation Badge](https://github.com/apache/nuttx/workflows/Build%20Documentation/badge.svg)](https://nuttx.apache.org/docs/latest/index.html)