27 lines
1.4 KiB
Markdown
27 lines
1.4 KiB
Markdown
## Contributing
|
|
|
|
Hi there! We're thrilled that you'd like to contribute to this project. Your help is essential for keeping it great.
|
|
|
|
This project adheres to the [Open Code of Conduct](http://todogroup.org/opencodeofconduct/#gh-ost/opensource@github.com). By participating, you are expected to uphold this code.
|
|
|
|
## Submitting a pull request
|
|
|
|
0. [Fork](https://github.com/github/gh-ost/fork) and clone the repository
|
|
0. Create a new branch: `git checkout -b my-branch-name`
|
|
0. Make your change, add tests, and make sure the tests still pass
|
|
0. Push to your fork and [submit a pull request](https://github.com/github/gh-ost/compare)
|
|
0. Pat your self on the back and wait for your pull request to be reviewed and merged.
|
|
|
|
Here are a few things you can do that will increase the likelihood of your pull request being accepted:
|
|
|
|
- Follow the [style guide](https://golang.org/doc/effective_go.html#formatting).
|
|
- Write tests.
|
|
- 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.
|
|
- Write a [good commit message](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html).
|
|
|
|
## Resources
|
|
|
|
- [Contributing to Open Source on GitHub](https://guides.github.com/activities/contributing-to-open-source/)
|
|
- [Using Pull Requests](https://help.github.com/articles/using-pull-requests/)
|
|
- [GitHub Help](https://help.github.com)
|