Contributing

GitHub flow

This is a rough outline of the workflow:

Create a topic branch from where you want to base your work. This is usually master.
Make commits of logical units (and add tests!).
Make sure your commit messages are in the proper format (see below).
Push your changes to a topic branch in your fork of the repository.
Submit a pull request.
Rebase and force-push to your fork's branch as necessary.

Thanks for you contributions!

sdlc/bootstrap

sdlc/build
sdlc/test

This is an example of a commit message:

add a cluster test command

this uses tmux to setup a test cluster that you can easily kill and
start for debugging.

The subject line fills in the blank of the sentence:

When this commit is merged, it will __________________________ .

This allows the message to be easier to read on github as well as in various git tools.

The subject line contains succinct description of the change.
- use imperative mood, present tense
- no dot (.) at the end
- max 72 chars
The body describes why the change is necessary.
- use imperative mood, present tense
- include motivation for the change and contrasts with previous behavior
- wrap lines at 72 chars when possible for text
- wrap lines at 100 chars when possible for code blocks