CoreOS projects are Apache 2.0 licensed and accept contributions via GitHub pull requests. This document outlines some of the conventions on development workflow, commit message formatting, contact points and other resources to make it easier to get your contribution accepted.
By contributing to this project you agree to the Developer Certificate of Origin (DCO). This document was created by the Linux Kernel community and is a simple statement that you, as a contributor, have the legal right to make the contribution. See the DCO file for details.
This is a rough outline of what a contributor's workflow looks like:
Thanks for your contributions!
We follow a rough convention for commit messages borrowed from AngularJS. This is an example of a commit:
feat(scripts/test-cluster): add a cluster test command this uses tmux to setup a test cluster that you can easily kill and start for debugging.
The format can be described more formally as follows:
<type>(<scope>): <subject> <BLANK LINE> <body> <BLANK LINE> <footer>
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.
The subject line contains a succinct description of the change.
Scopes can anything specifying the place of the commit change in the code base - for example, “api”, “store”, etc.
For more details on the commit format, see the AngularJS commit style guide.