github.com/tototoman/operator-sdk@v0.8.2/CONTRIBUTING.MD (about) 1 # How to contribute 2 3 Operator SDK is Apache 2.0 licensed and accepts contributions via GitHub pull requests. This document outlines some of the conventions on commit message formatting, contact points for developers, and other resources to help get contributions into operator-sdk. 4 5 # Email and Chat 6 7 - Email: [operator-framework][operator_framework] 8 9 ## Getting started 10 11 - Fork the repository on GitHub 12 - See the [developer guide](./doc/dev/developer_guide.md) for build instructions 13 14 ## Reporting bugs and creating issues 15 16 Reporting bugs is one of the best ways to contribute. However, a good bug report has some very specific qualities, so please read over our short document on [reporting bugs](./doc/dev/reporting_bugs.md) before submitting a bug report. This document might contain links to known issues, another good reason to take a look there before reporting a bug. 17 18 ## Contribution flow 19 20 This is a rough outline of what a contributor's workflow looks like: 21 22 - Create a topic branch from where to base the contribution. This is usually master. 23 - Make commits of logical units. 24 - Make sure commit messages are in the proper format (see below). 25 - Push changes in a topic branch to a personal fork of the repository. 26 - Submit a pull request to operator-framework/operator-sdk. 27 - The PR must receive a LGTM from two maintainers found in the MAINTAINERS file. 28 29 Thanks for contributing! 30 31 ### Code style 32 33 The coding style suggested by the Golang community is used in operator-sdk. See the [style doc](https://github.com/golang/go/wiki/CodeReviewComments) for details. 34 35 Please follow this style to make operator-sdk easy to review, maintain and develop. 36 37 ### Format of the commit message 38 39 We follow a rough convention for commit messages that is designed to answer two 40 questions: what changed and why. The subject line should feature the what and 41 the body of the commit should describe the why. 42 43 ``` 44 scripts: add the test-cluster command 45 46 this uses tmux to setup a test cluster that can easily be killed and started for debugging. 47 48 Fixes #38 49 ``` 50 51 The format can be described more formally as follows: 52 53 ``` 54 <subsystem>: <what changed> 55 <BLANK LINE> 56 <why this change was made> 57 <BLANK LINE> 58 <footer> 59 ``` 60 61 The first line is the subject and should be no longer than 70 characters, the second line is always blank, and other lines should be wrapped at 80 characters. This allows the message to be easier to read on GitHub as well as in various git tools. 62 63 ## Documentation 64 65 If the contribution changes the existing APIs or user interface it must include sufficient documentation to explain the use of the new or updated feature. Likewise the [CHANGELOG][changelog] should be updated with a summary of the change and link to the pull request. 66 67 68 [operator_framework]: https://groups.google.com/forum/#!forum/operator-framework 69 [changelog]: https://github.com/operator-framework/operator-sdk/blob/master/CHANGELOG.md