Skip to content

Commit eea9d15

Browse files
aiduxiaoxiongsimbit18
authored andcommitted
docs: Fix typos, formatting, and numbering in README.md and CONTRIBUTING.md.
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 <[email protected]>
1 parent e3eeaef commit eea9d15

File tree

2 files changed

+6
-8
lines changed

2 files changed

+6
-8
lines changed

CONTRIBUTING.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
Thank you for your interest in contributing to Apache NuttX RTOS :-)
44

55
If you haven't yet read
6-
[The Inviolable Principles of NuttX]( https://github.com/apache/nuttx/blob/master/INVIOLABLES.md)
6+
[The Inviolable Principles of NuttX](https://github.com/apache/nuttx/blob/master/INVIOLABLES.md)
77
please do so first.
88

99
Apache NuttX RTOS supports over 15 different architectures, 360+ boards,
@@ -355,8 +355,8 @@ See: https://github.com/apache/nuttx/blob/master/INVIOLABLES.md
355355
2. Single company / organization commit, review, and merge is not allowed.
356356
3. Merge of PRs with unresolved discussions and "change request" marks
357357
is not allowed.
358-
3. Self committed code merge with or without review is not allowed.
359-
4. Direct push to master is not allowed.
358+
4. Self committed code merge with or without review is not allowed.
359+
5. Direct push to master is not allowed.
360360

361361
Breaking these rules will be punished.
362362

@@ -395,7 +395,7 @@ Add g_ prefix to can_dlc_to_len and len_to_can_dlc to
395395
follow NuttX coding style conventions for global symbols,
396396
improving code readability and maintainability.
397397
* you can also use bullet points.
398-
* to note different thing briefly.
398+
* to note different things briefly.
399399
400400
Signed-off-by: AuthorName <Valid@EmailAddress>
401401
```

README.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,9 @@
33
</p>
44

55
![POSIX Badge](https://img.shields.io/badge/POSIX-Compliant-brightgreen?style=flat&label=POSIX)
6-
[![License](https://img.shields.io/badge/License-Apache%202.0-blue
7-
)](https://nuttx.apache.org/docs/latest/introduction/licensing.html)
6+
[![License](https://img.shields.io/badge/License-Apache%202.0-blue)](https://nuttx.apache.org/docs/latest/introduction/licensing.html)
87
![Issues Tracking Badge](https://img.shields.io/badge/issue_track-github-blue?style=flat&label=Issue%20Tracking)
9-
[![Contributors](https://img.shields.io/github/contributors/apache/nuttx
10-
)](https://github.com/apache/nuttx/graphs/contributors)
8+
[![Contributors](https://img.shields.io/github/contributors/apache/nuttx)](https://github.com/apache/nuttx/graphs/contributors)
119
[![GitHub Build Badge](https://github.com/apache/nuttx/workflows/Build/badge.svg)](https://github.com/apache/nuttx/actions/workflows/build.yml)
1210
[![Documentation Badge](https://github.com/apache/nuttx/workflows/Build%20Documentation/badge.svg)](https://nuttx.apache.org/docs/latest/index.html)
1311

0 commit comments

Comments
 (0)