Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Write several sections, "Why Contribute to NuttX", "Creating and Submitting Improvements." Reorganize other text.

...

Creating and Submitting Improvements

The All contributors, whether seasoned NuttX committers or new contributors, follow the same steps to create and submit improvements are roughly as follows:Obtain a copy submit a proposed change. These steps are outlined here. Further details are given in the remainder of this document.

All Contributors:

  • Optional: Before you begin work, discuss your proposed change on the dev@nuttx.apache.org mailing list. Someone else may already be working on a similar change and perhaps you could collaborate and split the effort. Also, a discussion could help you find out whether your changes are likely to be accepted, and input from other community members might provide some valuable insights.
  • Review the section "Criteria For Acceptance" in this document.
  • Obtain a copy of the source code, if you don't already have it. See the section Sources of NuttX Code. Working with a GIT clone may provide the path of least resistance, but you can also work from the latest versioned release tarball.
  • Develop your changes. Feel free to communicate with the dev@nuttx.apache.org mailing list as often as you need to for guidance.
  • Submit your changes. This can be achieved by one of several methods, including by GitHub Pull Request (PR) or emailing a textual GIT Pull Request or patch. See the section "How To Submit Changes For Review" in this document for details.

Community/Committer Review:

  • At this point, the community, especially committers, should review your proposed changes to ensure that the project's criteria are met. These are spelled out in the section "Criteria For Acceptance" in this document.
  • If any issues are found, you may be asked to correct them and re-submit your changes. Don't be discouraged if this happens; it's a normal part of the open source process. Committers may opt to go ahead and correct minor issues (such as coding style, etc.) instead of sending them back to you.
  • Once the review has taken place and the project's criteria are met, your changes are ready to be committed to the official repository. 

Notes:

  • No one is obligated to review a change. Generally, committers will review changes that interest them or affect areas they care about. Fortunately, the NuttX community is friendly and has a large following, so chances are pretty good that your changes will be reviewed. (You did discuss your ideas on the mailing list before investing a lot of time, right?)
  • Only committers are able to commit changes to the NuttX GIT repositories, but all members of the community are encouraged to participate in reviews and discussions. Committers are encouraged to weigh input from the larger community. If you are not (yet) a committer, being actively involved in the project and demonstrating good will and good judgment, can go a long way toward becoming a committer!

How To Submit Changes For Review

We wish to be as accommodating as possible to our users and contributors. As such, we provide several ways for you to 

...

By Emailing a Textual GIT Pull Request

How To Submit Changes For Review

...

Pull Request

...

Criteria For Acceptance

This section defines what sorts of things committers will examine and verify before allowing changes into NuttX.

...