Skip to content
This repository has been archived by the owner on Jan 27, 2023. It is now read-only.

Latest commit

 

History

History
29 lines (23 loc) · 1.11 KB

CONTRIBUTING.md

File metadata and controls

29 lines (23 loc) · 1.11 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

Code

  • Must be readable with meaningful naming, eg no short hand single character variable names

Testing

Write tests using rspec-puppet.

Ensure that you run rake test so that the tests pass before you raise your pull request.