From 2731ab5c19a9368e9260fbc1ff8ebcaaa3207dcd Mon Sep 17 00:00:00 2001 From: Matias N Date: Thu, 17 Sep 2020 23:01:39 -0300 Subject: [PATCH] Add CONTRIBUTING.md --- CONTRIBUTING.md | 41 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 41 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000000..ea5794d34a --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,41 @@ +# Contribution to Apache NuttX + +Hi! Thank you for wanting to contribute to Apache NuttX. + +## Guidelines + +In order to help us review your contribution successfully +it is very important you follow these guidelines: + + * Use descriptive **commit messages** and, if the change + warrants further description, do add a separate paragraph + like so: + + + + + + * Be sure to **fill in** the pull-request template with + meaningful content (be very descriptive, take your time). + Do **not** remove these sections or ignore them. + + * **Tip**: if you create a commit message as above, the + first line will be automatically used as PR title + and the rest added to the description. Use it as a + starting point to describe your PR. + + * Your should follow [NuttX C Coding Standard](https://nuttx.apache.org/docs/latest/contributing/coding_style.html) + + * 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. + + * Note that we require you to solve this issues + and adapt all modified files even if you didn't + introduce the problem yourself (this way, every + contribution gets us closer to compliance) + +## For more information + +For general notes on contributing to Apache NuttX continue reading [here](https://nuttx.apache.org/docs/latest/contributing/index.html).