Skip to content

Latest commit

 

History

History
26 lines (17 loc) · 1.28 KB

CONTRIBUTING.md

File metadata and controls

26 lines (17 loc) · 1.28 KB

Git workflow

  • Pull requests must contain a succint, clear summary of what the user need is driving this feature change.
  • Follow our Git styleguide
  • Make a feature branch
  • Ensure your branch contains logical atomic commits before sending a pull request - follow our Git styleguide
  • Pull requests are automatically integration tested, where applicable using Travis CI, which will report back on whether the tests still pass on your branch
  • You may rebase your branch after feedback if it's to include relevant updates from the master branch. We prefer a rebase here to a merge commit as we prefer a clean and straight history on master with discrete merge commits for features

Copy

  • Follow the style guide
  • URLs should use hyphens, not underscores

Code

  • Must be readable with meaningful naming, eg no short hand single character variable names
  • Follow our Ruby style guide

Testing

Write tests.

Images

  • optimise images as described in README