cederom commented on code in PR #15950: URL: https://github.com/apache/nuttx/pull/15950#discussion_r1997815998
########## CONTRIBUTING.md: ########## @@ -1,133 +1,445 @@ -# Contributing to Apache NuttX RTOS +# Apache NuttX RTOS Contributing Guidelines -Hi! Thank you for your interest in contributing to Apache NuttX RTOS :-) +Thank you for your interest in contributing to Apache NuttX RTOS :-) -## Guidelines +If you haven't yet read +[The Inviolable Principles of NuttX]( https://github.com/apache/nuttx/blob/master/INVIOLABLES.md) +please do so first. -To help us successfully review your contribution, it is very -important that you follow these guidelines. +Please note that NuttX supports over 15 different architectures, 360+ boards, +and 1600+ configurations, that are used in various projects and products around +the world. Remember that any code change may affect different users and their +businesses. Please try to keep your contributions high quality and compatible. -If you need more information please read the [Full Contributing Documentation](https://nuttx.apache.org/docs/latest/contributing/index.html). +To help us process your contributions smoothly, it is very important that you +follow the guidelines. NuttX is maintained by a small team of volunteers from +around the world. These rules are based on daily experiences and help us +to preserve long term self-compatibility and maintenance of the project. -### Coding Standard +This document is split into two main parts: -* You should follow [NuttX C Coding Standard](https://nuttx.apache.org/docs/latest/contributing/coding_style.html). + 1. Contribution Rules. + 2. Contribution Templates. -* Your code will be automatically checked by GitHub Continuous Integration - (CI) system. If you see the "check" step fails, it is possible that this - happens due to style errors. +If you need more information please read the +[Full Contributing Documentation](https://nuttx.apache.org/docs/latest/contributing/index.html) +or ask questions at our [Social Media channels](https://nuttx.apache.org/community). -* Note that we require you to solve these issues and adapt all modified files - even if you didn't introduce the problem yourself (this way, - every contribution gets us closer to compliance). -### Commits -* Each commit **must** contain a meaningful **commit message** that consist of: - * **topic** (mandatory). - * **description** (optional, separate with blank line from topic). +## 1. Contribution Rules. -* **Prefix** commit topic with a functional context - (i.e. `sched: Fixed compiler warning.`). +### 1.1. Goals. -* Provide only **signed commits** (`git commit -s`) with valid author - and email fields. +The rules presented are here to ensure high qualiy code and documentation, Review Comment: thank you fixed! :-) ########## CONTRIBUTING.md: ########## @@ -1,133 +1,445 @@ -# Contributing to Apache NuttX RTOS +# Apache NuttX RTOS Contributing Guidelines -Hi! Thank you for your interest in contributing to Apache NuttX RTOS :-) +Thank you for your interest in contributing to Apache NuttX RTOS :-) -## Guidelines +If you haven't yet read +[The Inviolable Principles of NuttX]( https://github.com/apache/nuttx/blob/master/INVIOLABLES.md) +please do so first. -To help us successfully review your contribution, it is very -important that you follow these guidelines. +Please note that NuttX supports over 15 different architectures, 360+ boards, +and 1600+ configurations, that are used in various projects and products around +the world. Remember that any code change may affect different users and their +businesses. Please try to keep your contributions high quality and compatible. -If you need more information please read the [Full Contributing Documentation](https://nuttx.apache.org/docs/latest/contributing/index.html). +To help us process your contributions smoothly, it is very important that you +follow the guidelines. NuttX is maintained by a small team of volunteers from +around the world. These rules are based on daily experiences and help us +to preserve long term self-compatibility and maintenance of the project. -### Coding Standard +This document is split into two main parts: -* You should follow [NuttX C Coding Standard](https://nuttx.apache.org/docs/latest/contributing/coding_style.html). + 1. Contribution Rules. + 2. Contribution Templates. -* Your code will be automatically checked by GitHub Continuous Integration - (CI) system. If you see the "check" step fails, it is possible that this - happens due to style errors. +If you need more information please read the +[Full Contributing Documentation](https://nuttx.apache.org/docs/latest/contributing/index.html) +or ask questions at our [Social Media channels](https://nuttx.apache.org/community). -* Note that we require you to solve these issues and adapt all modified files - even if you didn't introduce the problem yourself (this way, - every contribution gets us closer to compliance). -### Commits -* Each commit **must** contain a meaningful **commit message** that consist of: - * **topic** (mandatory). - * **description** (optional, separate with blank line from topic). +## 1. Contribution Rules. -* **Prefix** commit topic with a functional context - (i.e. `sched: Fixed compiler warning.`). +### 1.1. Goals. -* Provide only **signed commits** (`git commit -s`) with valid author - and email fields. +The rules presented are here to ensure high qualiy code and documentation, +standardized pull requests processing, as well as long term self-compatibilty Review Comment: thank you fixed! :-) -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: commits-unsubscr...@nuttx.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org
