Skip to content

Commit 0824c83

Browse files
author
Tom Krouper
authored
Merge pull request #5 from github/add-contributing
CONTRIBUTING.md added
2 parents 7a9c4bf + 26c38ca commit 0824c83

File tree

1 file changed

+26
-0
lines changed

1 file changed

+26
-0
lines changed

CONTRIBUTING.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
## Contributing
2+
3+
[fork]: https://github.com/github/puppet-orchestrator-for-mysql/fork
4+
[pr]: https://github.com/github/puppet-orchestrator-for-mysql/compare
5+
6+
Hi there! We're thrilled that you'd like to contribute to this project. Your help is essential for keeping it great.
7+
8+
## Submitting a pull request
9+
10+
0. [Fork][fork] and clone the repository
11+
0. Create a new branch: `git checkout -b my-branch-name`
12+
0. Make your change, add tests, and make sure the tests still pass
13+
0. Push to your fork and [submit a pull request][pr]
14+
0. Pat your self on the back and wait for your pull request to be reviewed and merged.
15+
16+
Here are a few things you can do that will increase the likelihood of your pull request being accepted:
17+
18+
- Write tests.
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+
- [Contributing to Open Source on GitHub](https://guides.github.com/activities/contributing-to-open-source/)
25+
- [Using Pull Requests](https://help.github.com/articles/using-pull-requests/)
26+
- [GitHub Help](https://help.github.com)

0 commit comments

Comments
 (0)