These are important.
People contributing code to this project must adhere to the following rules. These standards are in place to keep code clean, consistent, and stable.
There are two types of documentation: source and markdown.
All source code should be documented in accordance with the Go's documentation rules.
When creating or modifying the project's
README.md file or any of the
documentation in the
.docs directory, please keep the following rules in
All links to internal resources should be relative and if a link to another documentation resource, include the
.mdfile extension. This is so links to internal resources are valid when followed from GitHub or ReadTheDocs.
For example, the following link points to the anchor
However, the above link will return a 404 when followed while viewing this page via GitHub.
While it's recommended that users view the generated site documentation instead of the source Markdown directly, it's possible to make the above link work regardless. To fix the link, simply make it relative and add the Markdown file extension:
Now the link will work regardless from where it's viewed.
When creating or modifying the project documentation in the
.docsdirectory please ensure that it's being reviewed with the MkDocs tool. Once installed open a terminal window to the root of the project and execute the following:
$ mkdocs serve
The above command will serve the rendered documentation at http://localhost:8080 and changes made to the documentation are updated in real-time.
Style & Syntax¶
All source files should be processed by the gometalinter before committed. Any errors or warnings produced by the tools should be corrected before the source is committed.
In lieu of using Atom as the IDE, the project's
executes the above tools as part of the build process and will fail the build
if problems are discovered.
All source code and markdown should be limited to a width of 80 characters. This makes the file easier to read in text editors. For the markdown this will likely result in hard line breaks, but that's okay. GitHub and ReadTheDocs still produce the intended result when rendering the markdown.
All new work submitted to the project should have associated tests where applicable. If there is ever a question of whether or not a test is applicable then the answer is likely yes.
This project uses
Codecov for code coverage, and
all pull requests are processed just as a build from
master. If a pull request
decreases the project's code coverage, the pull request will be declined until
such time that testing is added or enhanced to compensate.
Commit messages should follow the guide 5 Useful Tips For a Better Commit Message. The two primary rules to which to adhere are:
Commit message subjects should not exceed 50 characters in total and should be followed by a blank line.
The commit message's body should not have a width that exceeds 72 characters.
For example, the following commit has a very useful message that is succinct without losing utility.
commit e80c696939a03f26cd180934ba642a729b0d2941 Author: akutz <firstname.lastname@example.org> Date: Tue Oct 20 23:47:36 2015 -0500 Added --format,-f option for CLI This patch adds the flag '--format' or '-f' for the following CLI commands: * adapter instances * device [get] * snapshot [get] * snapshot copy * snapshot create * volume [get] * volume attach * volume create * volume map * volume mount * volume path The user can specify either '--format=yml|yaml|json' or '-f yml|yaml|json' in order to influence how the resulting, structured data is marshaled prior to being emitted to the console.
Please note that the output above is the full output for viewing a commit. However, because the above message adheres to the commit message rules, it's quite easy to show just the commit's subject:
$ git show e80c696939a03f26cd180934ba642a729b0d2941 --format="%s" -s Added --format,-f option for CLI
It's also equally simple to print the commit's subject and body together:
$ git show e80c696939a03f26cd180934ba642a729b0d2941 --format="%s%n%n%b" -s Added --format,-f option for CLI This patch adds the flag '--format' or '-f' for the following CLI commands: * adapter instances * device [get] * snapshot [get] * snapshot copy * snapshot create * volume [get] * volume attach * volume create * volume map * volume mount * volume path The user can specify either '--format=yml|yaml|json' or '-f yml|yaml|json' in order to influence how the resulting, structured data is marshaled prior to being emitted to the console.
All developers are required to follow the GitHub Flow model when proposing new features or even submitting fixes.
Please ensure that branch names are lowercase, hyphenated, and adhere to the following naming convention:
Please note that although not explicitly stated in the referenced GitHub Flow model, all work should occur on a fork of this project, not from within a branch of this project itself.
Pull requests submitted to this project should adhere to the following guidelines:
Branches should be rebased off of the upstream master (or targeted release branch) prior to being opened as pull requests and again prior to merge. This is to ensure that the build system accounts for any changes that may only be detected during the build and test phase.
Unless granted an exception a pull request should contain only a single commit. This is because features and patches should be atomic -- wholly shippable items that are either included in a release, or not. Please squash commits on a branch before opening a pull request. It is not a deal-breaker otherwise, but please be prepared to add a comment or explanation as to why you feel multiple commits are required.