CONTRIBUTING.md (1484B)
1 # How to Contribute 2 3 ## Getting Started 4 5 - Fork the repository on GitHub 6 - Read the [README](README.markdown) for build and test instructions 7 - Play with the project, submit bugs, submit patches! 8 9 ## Contribution Flow 10 11 This is a rough outline of what a contributor's workflow looks like: 12 13 - Create a topic branch from where you want to base your work (usually master). 14 - Make commits of logical units. 15 - Make sure your commit messages are in the proper format (see below). 16 - Push your changes to a topic branch in your fork of the repository. 17 - Make sure the tests pass, and add any new tests as appropriate. 18 - Submit a pull request to the original repository. 19 20 Thanks for your contributions! 21 22 ### Format of the Commit Message 23 24 We follow a rough convention for commit messages that is designed to answer two 25 questions: what changed and why. The subject line should feature the what and 26 the body of the commit should describe the why. 27 28 ``` 29 scripts: add the test-cluster command 30 31 this uses tmux to setup a test cluster that you can easily kill and 32 start for debugging. 33 34 Fixes #38 35 ``` 36 37 The format can be described more formally as follows: 38 39 ``` 40 <subsystem>: <what changed> 41 <BLANK LINE> 42 <why this change was made> 43 <BLANK LINE> 44 <footer> 45 ``` 46 47 The first line is the subject and should be no longer than 70 characters, the 48 second line is always blank, and other lines should be wrapped at 80 characters. 49 This allows the message to be easier to read on GitHub as well as in various 50 git tools.