• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# Contribution to Apache NuttX
2
3Hi! Thank you for wanting to contribute to Apache NuttX.
4
5## Guidelines
6
7In order to help us review your contribution successfully
8it is very important you follow these guidelines:
9
10  * Use descriptive **commit messages** and, if the change
11    warrants further description, do add a separate paragraph
12    like so:
13
14        <first line (up to ~80 characters)>
15
16        <more paragraphs here>
17
18    * The first line should have a prefix to give context
19      (unless context is really clear), such as:
20
21          <keyword>: <message>
22          i.e sched: Fixed compiler warning
23
24  * Be sure to **fill in** the pull-request template with
25    meaningful content (be very descriptive, take your time).
26    Do **not** remove these sections or ignore them.
27
28    * **Tip**: if you create a commit message as above, the
29      first line will be automatically used as PR title
30      and the rest added to the description. Use it as a
31      starting point to describe your PR.
32
33  * You should follow [NuttX C Coding Standard](https://nuttx.apache.org/docs/latest/contributing/coding_style.html)
34
35    * Your code will be automatically checked by GitHub
36      Continuous Integration (CI) system. If you see the
37      "check" step fails, it is possible that this happens
38      due to style errors.
39
40    * Note that we require you to solve these issues
41      and adapt all modified files even if you didn't
42      introduce the problem yourself (this way, every
43      contribution gets us closer to compliance).
44
45## For more information
46
47For general notes on contributing to Apache NuttX continue reading [here](https://nuttx.apache.org/docs/latest/contributing/index.html).
48