1# Contributing
2
3Everyone is welcome to help make gocui better!
4
5When contributing to this repository, please first discuss the change you wish
6to make via issue, email, or any other method with the owners of this repository
7before making a change.
8
9## So all code changes happen through Pull Requests
10Pull requests are the best way to propose changes to the codebase. We actively
11welcome your pull requests:
12
131. Fork the repo and create your branch from `master` with a name like `feature/contributors-guide`.
142. If you've added code that should be tested, add tests.
153. If you've added code that need documentation, update the documentation.
164. Make sure your code follows the [effective go](https://golang.org/doc/effective_go.html) guidelines as much as possible.
175. Be sure to test your modifications.
186. Make sure your branch is up to date with the master branch.
197. Write a [good commit message](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html).
208. Create that pull request!
21
22## Code of conduct
23Please note by participating in this project, you agree to abide by the [code of conduct].
24
25[code of conduct]: https://github.com/awesome-gocui/gocui/blob/master/CODE-OF-CONDUCT.md
26
27## Any contributions you make will be under the license indicated in the [license](LICENSE.md)
28In short, when you submit code changes, your submissions are understood to be
29under the same license as the rest of project. Feel free to contact the maintainers if that's a concern.
30
31## Report bugs using Github's [issues](https://github.com/awesome-gocui/gocui/issues)
32We use GitHub issues to track public bugs. Report a bug by [opening a new
33issue](https://github.com/awesome-gocui/gocui/issues/new); it's that easy!