Skip to content

Latest commit

 

History

History
42 lines (27 loc) · 1.78 KB

CONTRIBUTING.md

File metadata and controls

42 lines (27 loc) · 1.78 KB
Raw

Contribution Guidelines

We welcome patches as long as you follow these guidelines:

Git workflow

  • Pull requests must contain a succinct, 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 when adding or changing functionality.

Run the tests with:

bundle exec rake spec integration_tests

Versioning

We use Semantic Versioning.

Releasing a new version

  1. Create a branch that proposes a new version number, and CHANGELOG
  2. Open a Pull Request - here is a good example
  3. Once merged into master a new version will be built and published