github.com/yrvsyh/lazygit@v0.8.1/CONTRIBUTING.md (about)

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