Skip to content

Latest commit

 

History

History
55 lines (38 loc) · 3.03 KB

CONTRIBUTING.md

File metadata and controls

55 lines (38 loc) · 3.03 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 MIT 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.

Found a bug?

  • Ensure the bug was not already reported by searching on GitHub under Issues.
  • If you're unable to find an open issue addressing the problem, open a new one. Be sure to include a title and clear description, as much relevant information as possible, and a code sample or a reproducable test case demonstrating the expected behavior that is not occurring.
  • If possible, use the relevant bug report templates to create the issue.

What should I know before submitting a pull request or issue

Thanks for taking the time to submit an issue and/or pull request. Before you hit the submit button please at a look at existing issues to see if there's one that tackles your issue or contribution.

If one does exist don't worry! You can also contribute to the existing issue or pull request by joining the conversation and giving feedback or testing the code or problem.

Submitting a pull request

  1. Fork and clone the repository
  2. Configure and install the dependencies: npm install
  3. Make sure the tests pass on your machine: npm run test
  4. Create a new branch: git checkout -b my-branch-name
  5. Make your change, add tests
  6. Make sure the tests still pass: npm test
  7. Make sure your code is correctly formatted: npm run format
  8. Make sure your code passes linting: npm run lint
  9. Make sure your code builds: npm run build
  10. Push to your fork and submit a pull request
  11. Pat your self on the back, have a 🌮 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

Thanks! ❤️ ❤️ ❤️

GitHub Professional Services Team :octocat: