Skip to content

Latest commit

 

History

History
42 lines (28 loc) · 2.19 KB

CONTRIBUTING.md

File metadata and controls

42 lines (28 loc) · 2.19 KB
Raw

Contributing

This project is intended to be a safe, welcoming space for collaboration. Contributors are expected to adhere to the Contributor Covenant code of conduct.

Hi there! We're thrilled that you'd like to contribute to this project. Your help is essential for keeping it great.

If you have any substantial changes that you would like to make, please open an issue first to discuss them with us.

Contributions to this project are released to the public under the project's open source license.

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

Submitting a pull request

  1. Fork and clone the repository.
  2. Configure and install the dependencies: bundle.
  3. Make sure the tests pass on your machine: bundle exec rake.
  4. Create a new branch: git checkout -b my-branch-name.
  5. Make your change, add tests, and make sure the tests still pass.
  6. Add an entry to the top of CHANGELOG.md for your changes.
  7. If it's your first time contributing, add yourself to docs/index.md.
  8. Push to your fork and submit a pull request.
  9. Pat yourself on the back and wait for your pull request to be reviewed and merged.

Here are a few things you can do that will increase the likelihood of your pull request being accepted:

  • Write tests.
  • Keep your change as focused as possible. If there are multiple changes you would like to make that are not dependent upon each other, consider submitting them as separate pull requests.
  • Write a good commit message.

Documentation

  1. Navigate to /docs.
  2. Configure and install the dependencies: bundle.
  3. Run Jekyll: bundle exec jekyll serve.
  4. Open the docs site at http://127.0.0.1:4000/.

Releasing

If you are the current maintainer of this gem:

  1. Run ./script/release and follow the instructions.