Skip to content

Latest commit

 

History

History
35 lines (25 loc) · 1.87 KB

CONTRIBUTING.md

File metadata and controls

35 lines (25 loc) · 1.87 KB

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.

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: npm install
  3. Build the project: npm run build
  4. Make sure the tests pass on your machine: npm run test
  5. Make sure the code is formatted correctly: npm run autoformat:check; if it is not, format it: npm run autoformat
  6. Create a new branch: git checkout -b my-branch-name
  7. Make your change, add tests, and make sure the tests and format checks still pass
  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.

Resources