Pull Request Process

April 7, 2016 ยท View on GitHub

ProTips:

One of the key jobs of validating a pull request is running a series of tests to check that it won't break any existing work when merging in, and that the work that is does add actually... works. We can check this using a CI service like Travis. It allows people to know without having to wait for a team member to see if they have made any functional error in their code.

Pull Request Process

Before submitting a pull request

Ask contributors to ensure that any install or build dependencies are removed before the end of the layer when doing a build.

General steps for completing this pull request

Please review the guidelines for contributing to this repository.

Checklist

Does your project contributions have steps to follow before being approved? Tests, documentation changing, etc?

Ensure that your pull request has followed all the steps below:

  • Code compilation
  • All tests passing
  • Extended the documentation, if applicable
  • Added myself to the AUTHORS file

Description

Ask the contributor to describe his pull request.

Proposed changes

Ask contributors about why you (or your project maintainers) would accept the pull request. If it solves a previous request, also ask to link to that issue.

Types of changes

Show in a checkbox-style, the expected types of changes your project is supposed to have:

  • New feature
  • Bugfix
  • So on...