Skip to content
This repository has been archived by the owner on Jun 24, 2024. It is now read-only.

Latest commit

 

History

History
46 lines (33 loc) · 2.43 KB

CONTRIBUTING.md

File metadata and controls

46 lines (33 loc) · 2.43 KB
Raw

Contributing

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

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

Opening an issue

Thank you for taking the time to open an issue, your feedback helps make GitHub Classroom better. Before opening an issue, please be sure that your issue hasn't already been asked by using GitHub search

Here are a few things, that will help us help you when opening an issue.

  • A descriptive title that gives an idea of what your issue refers to
  • A thorough description of the issue, (one word descriptions are very hard to understand)
  • Screenshots (if appropriate)
  • Links (if appropriate)

Submitting a pull request

  1. Fork and clone the repository
  2. Configure and install the dependencies: (See the README for more details)
  3. Make sure the tests pass on your machine: script/test
  4. Make sure the linters pass on your machine: script/linter
  5. Create a new branch: git checkout -b my-branch-name
  6. Make your change, add tests, and make sure the tests still pass
  7. Accept the Contributor License Agreement
  8. Push to your fork and submit a pull request
  9. Pat your self 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:

  • Follow the style guide.
  • 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.

Resources