Skip to content

Latest commit

 

History

History
66 lines (44 loc) · 3.66 KB

starting-contributing.md

File metadata and controls

66 lines (44 loc) · 3.66 KB

Contributing

Contact information for the core dev team and community can be found below. The PX4 project uses a three-branch Git branching model:

  • master is by default unstable and sees rapid development.
  • beta has been thoroughly tested. It's intended for flight testers.
  • stable points to the last release.

We try to retain a linear history through rebases and avoid the Github flow. However, due to the global team and fast moving development we might resort to merges at times.

To contribute new functionality, sign up for Github, then fork the repository, create a new branch, add your changes, and finally send a pull request. Changes will be merged when they pass our continuous integration tests.

All contributions have to be under the permissive BSD 3-clause license and all code must not impose any further constraints on the use.

Commits and Commit Messages

Please use descriptive, multi-paragraph commit messages for all non-trivial changes. Structure them well so they make sense in the one-line summary but also provide full detail.

Component: Explain the change in one sentence. Fixes #1234

Prepend the software component to the start of the summary
line, either by the module name or a description of it.
(e.g. "mc_att_ctrl" or "multicopter attitude controller").

If the issue number is appended as <Fixes #1234>, Github
will automatically close the issue when the commit is
merged to the master branch.

The body of the message can contain several paragraphs.
Describe in detail what you changed. Link issues and flight
logs either related to this fix or to the testing results
of this commit.

Describe the change and why you changed it, avoid to
paraphrase the code change (Good: "Adds an additional
safety check for vehicles with low quality GPS reception".
Bad: "Add gps_reception_check() function").

Reported-by: Name <[email protected]>

Use git commit -s to sign off on all of your commits. This will add signed-off-by: with your name and email as the last line.

This commit guide is based on best practices for the Linux Kernel and other projects maintained by Linus Torvalds.

Tests Flight Results

Test flights are important for quality assurance. Please upload the logs from the microSD card to Log Muncher and share the link on the PX4 Discuss along with a verbal flight report.

Forums and Chat

Weekly Dev Call

The PX4 Dev Team syncs up on its weekly dev call (connect via Mumble client).

  • TIME: 19:00h Zurich time, 1 p.m. Eastern Time, 10 a.m. Pacific Standard Time
  • Server: sitl01.dronetest.io
  • Port: 64738
  • Password: px4
  • The agenda is announced in advance on the PX4 Discuss
  • Issues and PRs may be labelled "devcall" to flag them for discussion