Skip to content

Latest commit

 

History

History
91 lines (61 loc) · 3.94 KB

CONTRIBUTING.md

File metadata and controls

91 lines (61 loc) · 3.94 KB
Raw

👈 Back to README

Contributing

We love pull requests from everyone. By participating in this project, you agree to abide by our code of conduct.

Developer setup steps are covered in the README. This file explains how our dev process works. These are just guidelines; nothing here is intended to be rigid or confusing. If you'd like to contribute and don't understand something here, reach out on IRC, and we'll be happy to offer solutions.

Saying Hello

If you're new to the project, please say hello in IRC! We can help you succeed by finding issues that are a good fit for your skills/interests, and ensuring you have a contact person to guide you through the bug fixing process, answer any questions, and help if you get stuck.

Find us in #testpilot IRC. If you need help with IRC setup, the Mozilla wiki has instructions.

Contributing code

We use the same process for community members and paid staff.

Tests

Tests should be written for new code contributed.

Further docs on testing.

Branches

Fork the project and create one branch per bug on your personal repo.

The branch name should describe the bug, not the fix. It should start with the bug number, and include a very short description of the bug, or a short version of the bug's title, like 150-broken-image-data.

Commit messages

Commit messages should generally follow this helpful advice, but please start your commit message with "Fixes #nn:", which eases skimming history later. For this reason, the first line will tend to be longer than the 50 chars suggested in that article; aim to keep it less than 72 chars.

Submitting the pull request

When you submit a pull request, please use the description field to explain in words the overall intention of your changes. A few sentences should be plenty. It's also ok to reuse the commit message, if you included a lot of discussion there.

At this point you're waiting on us. We like to at least comment on pull requests within three business days (and, typically, one business day). We may suggest some changes or improvements or alternatives.

Reviews

We try to avoid landing any code without at least a cursory review.

Reviewers will run through roughly the following checklist:

  • Does the code do what it says it does?
  • Is the proposed fix the right fix? Does it address the underlying cause of the bug?
  • Is the code as simple as possible, while still addressing the issue? Are there unnecessary abstractions or optimizations?
  • Does the code make sense? Can you understand it on a localized and global level?
  • Does the code belong where it is? Is there a better place to put it?
  • Does the code fit the overall style? This includes simple syntactic choices, as well as following broader patterns/architectural approaches used elsewhere in the codebase.
  • Are there enough comments in the code? If commented code was changed, have the comments been updated?
  • Are class, function, event, and variable names descriptive? Do they match the existing style?
  • Are boundary cases considered?
  • Are error cases handled?
  • All tests and linting pass on travisci?
  • Are there tests for new/changed code?

Merging

When a pull request has passed review, the reviewer generally merges the code.

Note: This guide is based on the CONTRIBUTING.md file written by thoughtbot for the factory_girl_rails project.