Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
61 lines (44 loc) · 1.87 KB

CONTRIBUTING.md

File metadata and controls

61 lines (44 loc) · 1.87 KB

Contributing

We love contributions. Here's a quick guide to get you started.

Our Contribution Process

Issues

Before submitting an issue, please check for existing issues for duplicates and confirm that it hasn't been fixed already in the master branch.

The issue description must include a whatsmybrowser.org link to ensure that contributions may be reviewed without needless feedback loops.

Pull Requests

Our contribution process follows the ideas of the GitHub Flow. Before submitting a pull request, please make sure that:

  1. If you've added code that should be tested, add tests!
  2. If you've changed APIs, update the documentation.
  3. The test suite passes.
  4. Your code follows our style guide.

The pull request description must include the following checklist at the top to ensure that contributions may be reviewed without needless feedback loops and that your contributions can be included as quickly as possible.

| Q             | A
| ------------- | ---
| Bug fix?      | [yes|no]
| New feature?  | [yes|no]
| BC breaks?    | [yes|no]
| Deprecations? | [yes|no]
| Fixed tickets | [comma separated list of tickets fixed by the PR]

Style Guide

We follow the polarmobile's style guide.

License

By contributing, you agree that your contributions will be licensed under the Apache 2.0 license.

Releasing

This section is for maintainers. Here's the current process for releasing:

  • Determine what version to release.
  • Run $ ./script/prepare-release version.
  • Create a pull request.
  • Merge pull request.
  • Run $ ./script/release.