Skip to content
This repository has been archived by the owner on Sep 19, 2019. It is now read-only.

Latest commit

 

History

History
33 lines (24 loc) · 1.27 KB

CONTRIBUTING.md

File metadata and controls

33 lines (24 loc) · 1.27 KB
Raw

We love pull requests from everyone. Follow the thoughtbot code of conduct while contributing.

Dependencies

Runes uses Carthage for dependency management. Once you have it installed, simply run carthage bootstrap to install the dependencies.

Contributing

  1. Fork the repo.
  2. Run the tests. We only take pull requests with passing tests, and it's great to know that you have a clean slate.
  3. Add a test for your change. Only refactoring and documentation changes require no new tests. If you are adding functionality or fixing a bug, we need a test!
  4. Make the test pass.
  5. Push to your fork and submit a pull request.

At this point you're waiting on us. We like to at least comment on, if not accept, pull requests within three business days (and, typically, one business day). We may suggest some changes or improvements or alternatives.

Some things that will increase the chance that your pull request is accepted,

  • Include tests that fail without your code, and pass with it
  • Update the documentation, the surrounding one, examples elsewhere, guides, whatever is affected by your contribution
  • Follow the existing style of the project