Skip to content

Latest commit

 

History

History
27 lines (15 loc) · 1.23 KB

CONTRIBUTING.md

File metadata and controls

27 lines (15 loc) · 1.23 KB

Contributing

Pull requests of all sizes are very much appreciated, below is a quick guide on how you can help:

  1. Fork the repository

  2. minicron uses Git Flow so preferably make sure you have that installed, here is a good explanation of how to use it

  3. Check out the develop branch, git flow init (w/ default prompt values), and start a feature git flow feature start yourfeature.

  4. Install a local copy of minicron like so: bundle & rake install

  5. Run the tests to be sure everything is working before you begin like so: rake spec

  6. Make your changes.

  7. With the exception of documentation changes, any changes should ideally have accompanying tests.

  8. Finish your feature git flow feature finish

  9. Submit your pull request from your develop branch to minicron's develop branch

Where possible I'm trying to adhere to the Ruby Community Styleguide so please try to do so when making your changes. Install a plugin for EditorConfig and your IDE should do a lot of this for you automatically!

Thanks!