Skip to content

Commit fb6ea64

Browse files
authored
Create CONTRIBUTING.md
Provide information on how to contribute to this project.
1 parent dad4b3b commit fb6ea64

File tree

1 file changed

+26
-0
lines changed

1 file changed

+26
-0
lines changed

CONTRIBUTING.md

+26
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
## Contributing
2+
3+
[fork]: https://github.com/github/brubeck/fork
4+
[pr]: https://github.com/github/brubeck/compare
5+
6+
Hi there! We're thrilled that you'd liske to contribute to this project. Your help is essential for keeping it great.
7+
8+
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).
9+
10+
## Submitting a pull request
11+
12+
0. [Fork][fork] and clone the repository
13+
0. Create a new branch: `git checkout -b my-branch-name`
14+
0. Make your change, push to your fork and [submit a pull request][pr]
15+
0. Pat your self on the back and wait for your pull request to be reviewed and merged.
16+
17+
Here are a few things you can do that will increase the likelihood of your pull request being accepted:
18+
19+
- 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.
20+
- Write a [good commit message](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html).
21+
22+
## Resources
23+
24+
- [How to Contribute to Open Source](https://opensource.guide/how-to-contribute/)
25+
- [Using Pull Requests](https://help.github.com/articles/about-pull-requests/)
26+
- [GitHub Help](https://help.github.com)

0 commit comments

Comments
 (0)