2018-08-07 14:28:52 +02:00
|
|
|
# Contributing
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
♥ We love pull requests from everyone !
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
When contributing to this repository, please first discuss the change you wish
|
|
|
|
|
to make via issue, email, or any other method with the owners of this repository
|
|
|
|
|
before making a change.
|
|
|
|
|
|
|
|
|
|
## So all code changes happen through Pull Requests
|
|
|
|
|
Pull requests are the best way to propose changes to the codebase. We actively
|
|
|
|
|
welcome your pull requests:
|
|
|
|
|
|
|
|
|
|
1. Fork the repo and create your branch from `master`.
|
|
|
|
|
2. If you've added code that should be tested, add tests.
|
|
|
|
|
3. If you've added code that need documentation, update the documentation.
|
2018-09-06 17:31:19 +02:00
|
|
|
4. Make sure your code follows the [effective go](https://golang.org/doc/effective_go.html) guidelines as much as possible.
|
|
|
|
|
5. Be sure to test your modifications.
|
|
|
|
|
6. Write a [good commit message](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html).
|
|
|
|
|
7. Issue that pull request!
|
2018-08-07 14:28:52 +02:00
|
|
|
|
|
|
|
|
## Code of conduct
|
|
|
|
|
Please note by participating in this project, you agree to abide by the [code of conduct].
|
|
|
|
|
|
2018-08-07 14:59:22 +02:00
|
|
|
[code of conduct]: https://github.com/jesseduffield/lazygit/blob/master/CODE-OF-CONDUCT.md
|
2018-08-07 14:28:52 +02:00
|
|
|
|
|
|
|
|
## Any contributions you make will be under the MIT Software License
|
|
|
|
|
In short, when you submit code changes, your submissions are understood to be
|
|
|
|
|
under the same [MIT License](http://choosealicense.com/licenses/mit/) that
|
|
|
|
|
covers the project. Feel free to contact the maintainers if that's a concern.
|
|
|
|
|
|
|
|
|
|
## Report bugs using Github's [issues](https://github.com/jesseduffield/lazygit/issues)
|
|
|
|
|
We use GitHub issues to track public bugs. Report a bug by [opening a new
|
2018-08-07 14:59:22 +02:00
|
|
|
issue](https://github.com/jesseduffield/lazygit/issues/new); it's that easy!
|
