Skip to content

Commit 5ea8bf4

Browse files
authored
Create CONTRIBUTING.md
1 parent 35b0571 commit 5ea8bf4

1 file changed

Lines changed: 35 additions & 0 deletions

File tree

CONTRIBUTING.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/catalyst/fork
4+
[pr]: https://github.com/github/catalyst/compare
5+
[style]: https://github.com/styleguide/ruby
6+
[code-of-conduct]: CODE_OF_CONDUCT.md
7+
8+
Hi there! We're thrilled that you'd like to contribute to this project. Your help is essential for keeping it great.
9+
10+
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.md).
11+
12+
Please note that this project is released with a [Contributor Code of Conduct][code-of-conduct]. By participating in this project you agree to abide by its terms.
13+
14+
## Submitting a pull request
15+
16+
0. [Fork][fork] and clone the repository
17+
0. Configure and install the dependencies: `npm i`
18+
0. Make sure the tests pass on your machine: `npm t`
19+
0. Create a new branch: `git checkout -b my-branch-name`
20+
0. Make your change, add tests, and make sure the tests still pass
21+
0. Push to your fork and [submit a pull request][pr]
22+
0. Pat your self 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)