rubyforgood/habitat_humanity

View on GitHub
CONTRIBUTING.md

Summary

Maintainability
Test Coverage
# Contributing

We ♥ contributors! By participating in this project, you agree to abide by the
Ruby for Good [code of conduct].

[code of conduct]: https://github.com/rubyforgood/code-of-conduct

Here are the basic steps to submit a pull request. Make sure that you're working
on an [open issue]–if the relevant issue doesn't exist, open it!

[open issue]: https://github.com/rubyforgood/habitat_humanity/issues

1. Claim an issue on [our issue tracker][open issue] by assigning it to yourself
   (core team member) or commenting. If the issue doesn't exist yet, open it.

2. Fork the repo.

3. Run `./bin/setup`.

4. 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 rake`

5. Add a test for your change. If you are adding functionality or fixing a
   bug, you should add a test!

6. Make the test pass.

7. Push to your fork and submit a pull request. Include the issue number
   (ex. `Resolves #1`) in the PR description.

At this point you're waiting on us–we'll try to respond to your PR quickly.
We may suggest some changes or improvements or alternatives.

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

* 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