Thank you for investing your time in contributing to this project! Any contribution you make will be reflected in the next release's README.md CONTRIBUTERS section.
Follow the Code of Conduct to keep this community approachable and respectable.
In this guide you will get an overview of the contribution workflow from opening an issue, creating a PR, reviewing, and merging the PR.
To get an overview of the project, read the README.md. Here are some resources to help you get started with open source contributions:
- Finding ways to contribute to open source on GitHub
- Set up Git
- GitHub flow
- Collaborating with pull requests
-
Please familiarize yourself with the source code of the project, including example projects listed in examples.
-
Read the roadmap listed in the README.md.
-
Read the open issues to see if there is anything in progress addressing the feature or bug request you are interested in.
If the feature or bug is not listed in the open issues then create a new feature request or bug issue and follow the prompts.
Scan through the open issues to find one that interests you. You can narrow down the search using labels as filters. As a general rule, we don’t assign issues to anyone. If you find an issue to work on, you are welcome to open a PR with a fix.
-
Clone the repo locally.
-
Fork off of the
mainbranch. -
Make your code change, with new tests if applicable, ensuring that
npm run lintandnpm testpass without modification of existing tests or code.
Commit the changes once you are happy with them. See Atom's contributing guide to know how to use emoji for commit messages.
When you're finished with the changes, create a pull request, also known as a PR.
- Follow the instructions in the pull request template ensuring that you change
[ ]to[x]when each item is complete.
Once your PR is merged, your contributions will be publicly visible on the README.md's CONTRIBUTERS section.