Sha256: 70c86aa9f1f8a701860093a1fc788e2191a5ec6176ecef812d58b1fa399c5192

Contents?: true

Size: 1.12 KB

Versions: 5

Compression:

Stored size: 1.12 KB

Contents

We love pull requests. Here's a quick guide:

1. Fork the repo and `bundle install`

2. Set up Appraisal, which helps us test against multiple Rails versions:
   `bundle exec appraisal install`

3. Run the tests. We only take pull requests with passing tests, and it's great
   to know that you have a clean slate: `bundle exec appraisal rake`

4. 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!

5. Make the test pass.

6. 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,
taken straight from the Ruby on Rails guide:

* Use Rails idioms and helpers
* 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

Version data entries

5 entries across 5 versions & 1 rubygems

Version Path
clearance-1.5.0 CONTRIBUTING.md
clearance-1.4.3 CONTRIBUTING.md
clearance-1.4.2 CONTRIBUTING.md
clearance-1.4.1 CONTRIBUTING.md
clearance-1.4.0 CONTRIBUTING.md