Skip to content

Latest commit

 

History

History
46 lines (33 loc) · 1.97 KB

CONTRIBUTING.md

File metadata and controls

46 lines (33 loc) · 1.97 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. Create a new branch: git checkout -b my-branch-name
  4. Make your change, add tests, and make sure the tests still pass
  5. Push to your fork and submit a pull request
  6. 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:

  • 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.
  • Execute npm run build-dist and fix any issues arising from that

Running tests

When running tests locally, a valid classic GitHub token with the repo scope is required for tests to pass.

  • Export the token in the current shell: export GITHUB_TOKEN=<contents>
  • Run tests npm test

Resources