github.com/developest/gtm-enhanced@v1.0.4-0.20220111132249-cc80a3372c3f/CONTRIBUTING.md (about) 1 # Contributing to GTM 2 We love your input! We want to make contributing to this project as easy and transparent as possible. 3 4 ## We Develop with Github 5 We use Github to host code, to track issues and feature requests, as well as accept pull requests. 6 7 ## We Use Pull Requests for code changes 8 Pull requests are the best way to propose changes to the codebase. 9 To purpose a code change do the following: 10 11 1. Fork the repo and create your branch from `develop`. 12 2. If you've added code that should be tested, add tests. 13 3. If you've changed something, that should be documented, update the documentation. 14 4. Ensure the test suite passes. 15 5. Make sure your code lints. 16 6. Issue that pull request! 17 7. If there is any feedback in pull request, do the necessary changes or explain why you did something in a way you did. 18 8. If everything is good, a maintainer will merge your pull request, and the code will be included in the next release. 19 20 ## Any contributions you make will be under the MIT Software License 21 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. 22 Feel free to contact the maintainers if that's a concern. 23 24 ## Report bugs using Github's Issues 25 We use GitHub issues to track public bugs. Report a bug by opening a new issue with detailed description! 26 27 **Great Bug Reports** tend to have: 28 29 - A quick summary and/or background 30 - Steps to reproduce 31 - Be specific! 32 - Give sample code if you can (eg. shell script). 33 - What you expected would happen 34 - What actually happens 35 - Notes (possibly including why you think this might be happening, or stuff you tried that didn't work) 36 37 People *love* thorough bug reports. I'm not even kidding. 38 39 ## Use a Consistent Coding Style 40 41 * Make sure there are no `gofmt` issues 42 * Make sure your coding style complies with already existing code 43 44 ## License 45 By contributing, you agree that your contributions will be licensed under its MIT License.