Skip to content

Commit 8a5ec17

Browse files
authored
Create CONTRIBUTING-js.md for project contributions
Added a contributing guide for the project.
1 parent d0d57a5 commit 8a5ec17

1 file changed

Lines changed: 35 additions & 0 deletions

File tree

CONTRIBUTING-js.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
## Contributing
2+
3+
[fork]: https://github.com/github/REPO/fork
4+
[pr]: https://github.com/github/REPO/compare
5+
[style]: https://github.com/github/REPO/blob/main/.eslintrc.json
6+
7+
Hi there! We're thrilled that you'd like to contribute to this project. Your help is essential for keeping it great.
8+
9+
Contributions to this project are [released](https://help.github.com/articles/github-terms-of-service/#6-contributions-under-repository-license) to the public under the [project's open source license](LICENSE.txt).
10+
11+
Please note that this project is released with a [Contributor Code of Conduct](CODE_OF_CONDUCT.md). By participating in this project you agree to abide by its terms.
12+
13+
## Submitting a pull request
14+
15+
1. [Fork][fork] and clone the repository
16+
1. Configure and install the dependencies: `npm install`
17+
1. Make sure the tests pass on your machine: `npm run test`
18+
1. Make sure linter passes on your machine: `npm run lint`
19+
1. Create a new branch: `git checkout -b my-branch-name`
20+
1. Make your change, add tests, and make sure the tests and linter still pass
21+
1. Push to your fork and [submit a pull request][pr]
22+
1. Pat yourself on the back and wait for your pull request to be reviewed and merged.
23+
24+
Here are a few things you can do that will increase the likelihood of your pull request being accepted:
25+
26+
- Follow the [style guide][style].
27+
- Write tests.
28+
- 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.
29+
- Write a [good commit message](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html).
30+
31+
## Resources
32+
33+
- [How to Contribute to Open Source](https://opensource.guide/how-to-contribute/)
34+
- [Using Pull Requests](https://help.github.com/articles/about-pull-requests/)
35+
- [GitHub Help](https://help.github.com)

0 commit comments

Comments
 (0)