muyangren
eea9d15b41
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 <aiduxiaoxiong@users.noreply.github.com>
2026-03-23 12:05:24 +01:00
Tomasz 'CeDeROM' CEDRO
8699c675e2
doc: Contributing Guide updates.
...
* As voted in https://www.mail-archive.com/dev@nuttx.apache.org/msg14264.html .
* Contributing Guide nomenclature align.
* Mention CG locations (git and doc).
* Reference NuttX Documentation, Contributing, and Security.
* Added Contributing Guide to NuttX Documentation (md include to stay in sync).
* Breaking Changes marking update:
* `[BREAKING]` title tag replaced with `!` (exclamation mark).
* `BREAKING CHANGES:` description brief with quick-fix instructions added.
* Breaking change git commit and pr template examples added.
Signed-off-by: Tomasz 'CeDeROM' CEDRO <tomek@cedro.info>
2026-02-19 12:11:14 -05:00
Lars Kruse
3ce85ca54e
style: fix spelling in code comments and strings
2025-05-23 10:48:41 +08:00
Tomasz 'CeDeROM' CEDRO
b37a5277ac
202503 Apache NuttX RTOS Contributing Guidelines update.
...
* This change comes from vast mailing list discussions on low PR/COMMIT
quality, breaking changes, code quality, long term self-compatibility
and maintenance, review problems, and how to improve things.
* Contributing Guidelines updates vote history:
1. https://www.mail-archive.com/dev@nuttx.apache.org/msg12584.html
2. https://www.mail-archive.com/dev@nuttx.apache.org/msg12723.html
Signed-off-by: Tomasz 'CeDeROM' CEDRO <tomek@cedro.info>
2025-03-17 08:30:37 -03:00
Tomasz 'CeDeROM' CEDRO
2c5091415e
Contributing and PR template fix.
...
* Fix CONTRIBUTING.md github link reference.
* Full URL is provided to avoid relative/fork reference issues.
* Minor update on full contributing documentation.
Signed-off-by: Tomasz 'CeDeROM' CEDRO <tomek@cedro.info>
2024-10-12 08:12:05 +08:00
Tomasz 'CeDeROM' CEDRO
140ce28616
Update github pull request template.
...
* Update CONTRIBUTING.md guide with hints and examples.
* Minor GitHub Pull Request Template update hinting expected information.
Signed-off-by: Tomasz 'CeDeROM' CEDRO <tomek@cedro.info>
2024-10-11 15:45:36 +08:00
Xiang Xiao
2c5f653bfd
Remove the tail spaces from all files except Documentation
...
Signed-off-by: Xiang Xiao <xiaoxiang@xiaomi.com>
2023-02-26 13:24:24 -08:00
Matias N
0c8870f14e
CONTRIBUTING.md: add example
...
Co-authored-by: David Sidrane <David.Sidrane@Nscdg.com>
2020-11-18 10:04:57 -08:00
Matias N
06fa2a4001
CONTRIBUTING.md: talk about preferred commit message format
2020-11-18 10:04:57 -08:00
Nathan Hartman
bcb6c30dc7
CONTRIBUTING.md: Minor grammar fixes.
...
CONTRIBUTING.md:
* Replace "you" with "your"
* Replace "this" with "these"
* Add one period
2020-09-18 16:43:48 -03:00
Matias N
2731ab5c19
Add CONTRIBUTING.md
2020-09-17 21:30:47 -07:00
