Contributing to MAVLink

We follow the Github flow development model. Contributions fall into two main categories: Design and micro-service changes include new features that come with a state machine and message specifications for a new type of interface (examples: parameter or mission protocol). These are major contributions requiring a lot of vetting and should come with a RFC pull request in https://github.com/mavlink/rfcs. Protocol specification and documentation changes are usually changes with less impact and can be directly raised as pull requests against this repository.

Below we explain the processes for contributing to each category and how to raise a pull request.

How to Contribute Design and Micro-service Changes

• Open a pull request against the RFC repository containing a new RFC number https://github.com/mavlink/rfcs and use the template in the 0000 RFC.
• Reach out to the community on Slack and on http://discuss.dronecode.org to raise awareness
• Address concerns by pushing more commits to the pull request

How to Contribute Protocol Specification Changes

• Open a pull request against the specification repository: https://github.com/mavlink/mavlink
• Reach out to the community on Slack and on http://discuss.dronecode.org to raise awareness
• Address concerns by pushing more commits to the pull request

How to Open a Pull Request

1. First fork and clone the project project.

2. Create a feature branch off master

   git checkout -b mydescriptivebranchname
   

   Always branch off master for new features.

3. Commit your changes with a descriptive commit message.

   • Include context information, what was fixed, and an issue number (Github will link these then conveniently)

   • Example:

     Change the attitude output spec documentation
     
     - Fixes a typo
     - Clarifies that units are radians
     
     Fixes issue #123
     

4. Test your changes (we may ask you for test results in your PR).

5. Push changes to your repo:

   git push origin mydescriptivebranchname
   

6. Send a pull request to merge changes in the branch.

Dev Call

We have a regular dev call that is open to anyone who is interested in contributing to the project!