tenfourfox/addon-sdk/source/CONTRIBUTING.md

Overview

• Changes should follow the design guidelines, as well as the coding style guide
• All changes need tests
• In order to land, changes need a review by one of the Jetpack reviewers
• Changes may need an API review
• Changes may need a review from a Mozilla platform domain-expert

If you have questions, ask in #jetpack on IRC or on the Jetpack mailing list.

How to Make Code Contributions

To write code for the Jetpack project, follow these steps:

1. Look for your issue in the list of bugs already filed. If you don't already know what you want to do, we keep a list of good first bugs.
2. If no bug exists, make one.
3. Get the code: get a GitHub account, fork the Add-on SDK repo, and clone it to your machine.
4. Make your changes. Changes should follow the design guidelines as well as the coding style guide.
5. Write tests: unit testing introduction, unit testing API.
6. Submit a pull request with the changes and a title in the form of Bug XXX - description.
7. Make sure that Travis CI tests are passing for your branch.
8. Copy the pull request link from GitHub and paste it in as an attachment to the bug.
9. Each pull request should ideally contain only one commit, so squash the commits if necessary.
10. Flag the attachment for code review from one of the Jetpack reviewers listed below. This step is optional, but could speed things up.
11. Address any issues mentioned in the review.

Finally, once the review is positive, a team member will do the merging

Good First Bugs

There is a list of good first bugs here.

Reviewers

All changes need a review by someone on the Jetpack review crew:

• @mossop
• @gozala
• @ZER0
• @jsantell
• @zombie

For review of Mozilla platform usage and best practices, ask [@autonome], [@0c0w3], or @mossop to find the domain expert.

For API and developer ergonomics review, ask @gozala.