gecko-dev/addon-sdk/source/CONTRIBUTING.md

3.1 KiB

Overview

  • Changes should follow the design guidelines, as well as coding style guide for Jetpack
  • All changes must be accompanied by tests
  • In order to land, changes must have review from a core Jetpack developer
  • Changes should have additional API review when needed
  • Changes should have additional review from a Mozilla platform domain-expert when needed

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

How to Make Code Contributions

If you have code that you'd like to contribute the Jetpack project, follow these steps:

  1. Look for your issue in the bugs already filed
  2. If no bug exists, submit one
  3. Make your changes, per the Overview
  4. Write a test (intro, API)
  5. Submit pull request with changes and a title in a form of Bug XXX - description
  6. Copy the pull request link from GitHub and paste it in as an attachment to the bug
  7. Each pull request should idealy contain only one commit, so squash the commits if necessary.
  8. Flag the attachment for code review from one of the Jetpack reviewers listed below. This step is optional, but could speed things up.
  9. Address any nits (ie style changes), or other issues mentioned in the review.
  10. Finally, once review is approved, a team member will do the merging

Good First Bugs

There is a list of good first bugs here.

Reviewers

All changes must be reviewed by someone on the Jetpack review crew:

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.