CONTRIBUTING.md 1.55 KB
Newer Older
Lorenz Meier's avatar
Lorenz Meier committed
1
2
3
4
5
6
7
8
9
10
11
12
13
# Contributing to PX4 Firmware

We follow the [Github flow](https://guides.github.com/introduction/flow/) development model.

### Fork the project, then clone your repo

First [fork and clone](https://help.github.com/articles/fork-a-repo) the project project.

### Create a feature branch

*Always* branch off master for new features.

```
Lorenz Meier's avatar
Lorenz Meier committed
14
git checkout -b mydescriptivebranchname
Lorenz Meier's avatar
Lorenz Meier committed
15
16
17
18
```

### Edit and build the code

19
The [developer guide](http://dev.px4.io/) explains how to set up the development environment on Mac OS, Linux or Windows. Please take note of our [coding style](https://dev.px4.io/master/en/contribute/code.html) when editing files.
Lorenz Meier's avatar
Lorenz Meier committed
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43

### Commit your changes

Always write descriptive commit messages and add a fixes or relates note to them with an [issue number](https://github.com/px4/Firmware/issues) (Github will link these then conveniently)

**Example:**

```
Change how the attitude controller works

- Fixes rate feed forward
- Allows a local body rate override

Fixes issue #123
```

### Test your changes

Since we care about safety, we will regularly ask you for test results. Best is to do a test flight (or bench test where it applies) and upload the logfile from it (on the microSD card in the logs directory) to Google Drive or Dropbox and share the link.

### Push your changes

Push changes to your repo and send a [pull request](https://github.com/PX4/Firmware/compare/).

Daniel Robinson's avatar
Daniel Robinson committed
44
Make sure to provide some testing feedback and if possible the link to a flight log file. Upload flight log files to [Flight Review](http://logs.px4.io) and link the resulting report.