|
| 1 | +# How to Contribute |
| 2 | + |
| 3 | +Cloudbase-init project is [Apache 2.0 licensed](LICENSE) and accepts |
| 4 | +contributions via GitHub pull requests. |
| 5 | + |
| 6 | +This document outlines some of the conventions on |
| 7 | +development workflow, commit message formatting, contact points and other |
| 8 | +resources to make it easier to get your contribution accepted. |
| 9 | + |
| 10 | +# Certificate of Origin |
| 11 | + |
| 12 | +By contributing to this project you agree to the Developer Certificate of |
| 13 | +Origin (DCO). This document was created by the Linux Kernel community and is a |
| 14 | +simple statement that you, as a contributor, have the legal right to make the |
| 15 | +contribution. See the [DCO](DCO) file for details. |
| 16 | + |
| 17 | +All code contributions must include a valid "Signed-off-by" line. |
| 18 | + |
| 19 | +Assignment of copyright is not required to contribute code. |
| 20 | +Code is contributed under the terms of the applicable [Apache 2.0 license](LICENSE). |
| 21 | + |
| 22 | +## Contribution Flow |
| 23 | + |
| 24 | +This is a rough outline of what a contributor's workflow looks like: |
| 25 | + |
| 26 | +- Create a topic branch from where you want to base your work (usually master). |
| 27 | +- Make commits of logical units. |
| 28 | +- Make sure your commit messages are in the proper format (see below). |
| 29 | +- Make sure the unit tests pass, and add any new unit tests as appropriate. |
| 30 | +- Push your changes to a topic branch in your fork of the repository. |
| 31 | +- Enable github actions and make sure the workflows pass. |
| 32 | +- Submit a pull request to the original repository. |
| 33 | + |
| 34 | +Thanks for your contributions! |
| 35 | + |
| 36 | +### Format of the Commit Message |
| 37 | + |
| 38 | +We follow a rough convention for commit messages that is designed to answer two |
| 39 | +questions: what changed and why. The subject line should feature the what and |
| 40 | +the body of the commit should describe the why. |
| 41 | + |
| 42 | +``` |
| 43 | +scripts: add the test-cluster command |
| 44 | +
|
| 45 | +this uses tmux to setup a test cluster that you can easily kill and |
| 46 | +start 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 |
| 62 | +second line is always blank, and other lines should be wrapped at 80 characters. |
| 63 | +This allows the message to be easier to read on GitHub as well as in various |
| 64 | +git tools. |
0 commit comments