Skip to content

Latest commit

 

History

History
33 lines (23 loc) · 1.55 KB

CONTRIBUTING.md

File metadata and controls

33 lines (23 loc) · 1.55 KB

Contributing

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

This project is released with a code of conduct. By contributing to this project you agree to abide by its terms.

Submitting an Issue

  1. In the repository navigation, click "Issues"
  2. Click "New issue"
  3. Choose "Bug Report" to create a report to help us improve or "Feature Request" to suggest an idea for the project
  4. Use the provided template to create your issue

Submitting a Pull Request

  1. Fork and clone the repository
  2. Configure and install any dependencies
  3. Make sure the tests pass on your machine
  4. Create a new branch
  5. Make your change, add tests, and make sure the tests still pass
  6. Push to your fork and submit a pull request
  7. 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:

  • Keep your change as focused as possible - if there are multiple changes you would like to make that are not dependent upon each other - submit them as separate pull requests
  • Write a good commit message

Resources