Skip to content

Pull Request Practices

Julia Nguyen edited this page Jul 22, 2018 · 10 revisions

If you've been added as a collaborator to the repository, please do not push unless the commit you are making is trivial i.e. doesn't require a code review. If you're unsure about this, please ask!

  • Please run Static Code Analysis locally before you make a pull request, don't rely on Codeclimate to do that for you.
  • Make sure you run the test suite locally before you make a pull request, don't rely on CircleCI to do that for you.
  • Make sure commit messages are clear and concise are tagged with the issue number e.g. "[#99] Fixes some sample issue".
  • Make sure pull requests reference the corresponding issue.
  • Make sure any issues or pull requests that are UI/UX focused have appropriate screenshots.
  • As a pull request (PR) reviewer, if you think the PR is good to go (including passing tests) make sure to comment with LGTM (looks good to me). You can either merge it yourself or tell the PR creator to do it themselves.
  • If you add or modify a model, please run annotate to update the schema comments and rake db:drop db:create db:migrate; rake db:schema:load to update db/schema.rb.

Everyone is encouraged to participate in code reviews, so please do so!

Clone this wiki locally