Jetpack/Contribution: Difference between revisions

From MozillaWiki
Jump to navigation Jump to search
(→‎Reviewers: update brian's bugzilla address)
m (→‎How to Make Code Contributions: Update out-of-date link to unit-test API)
Line 18: Line 18:
# If no bug exists, [https://bugzilla.mozilla.org/enter_bug.cgi?product=Add-on%20SDK&component=general file one here]
# If no bug exists, [https://bugzilla.mozilla.org/enter_bug.cgi?product=Add-on%20SDK&component=general file one here]
# Make your changes, per the [[Labs/Jetpack/Contribution#Overview|Overview]]
# Make your changes, per the [[Labs/Jetpack/Contribution#Overview|Overview]]
# Write a test ([https://jetpack.mozillalabs.com/sdk/latest/docs/#guide/packaging intro], [https://jetpack.mozillalabs.com/sdk/latest/docs/#module/jetpack-core/unit-test API])
# Write a test ([https://jetpack.mozillalabs.com/sdk/latest/docs/#guide/packaging intro], [https://jetpack.mozillalabs.com/sdk/latest/docs/#module/api-utils/unit-test API])
# Attach your code changes and tests in a combined patch to the bug
# Attach your code changes and tests in a combined patch to the bug
# Ask for code review by setting one or more "review" flags on your attachment to "?" and entering the email of the appropriate developer (noted in [[Labs/Jetpack/Contribution#Reviewers|Reviewers]] below)
# Ask for code review by setting one or more "review" flags on your attachment to "?" and entering the email of the appropriate developer (noted in [[Labs/Jetpack/Contribution#Reviewers|Reviewers]] below)

Revision as of 21:56, 24 January 2011

Overview

  • If you're implementing a JEP, see the So You're Implementing a JEP guide
  • Changes should follow the design guidelines for Jetpack
  • Changes should follow the code style guide for Jetpack
  • All changes must be accompanied by tests
  • In order to land, patches must have review from a core Jetpack developer
  • Patches should have additional API review when needed
  • Patches 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, file one here
  3. Make your changes, per the Overview
  4. Write a test (intro, API)
  5. Attach your code changes and tests in a combined patch to the bug
  6. Ask for code review by setting one or more "review" flags on your attachment to "?" and entering the email of the appropriate developer (noted in Reviewers below)

Reviewers

  • All changes must be reviewed by someone on the Jetpack review crew:
    • Atul (avarma@mozilla.com)
    • Brian (warner@mozilla.com, in bugzilla: warner-bugzilla@lothar.com)
    • Dietrich (dietrich@mozilla.com)
    • Drew (adw@mozilla.com)
    • Myk (myk@mozilla.org)
  • For review of Mozilla platform usage and best practices, ask Dietrich, Drew, or Myk to find the domain expert.
  • For API and developer ergonomics review, ask Myk (myk@mozilla.org).