## How to Contribute The Rook project in under [Apache 2.0 license](LICENSE). We accept contributions via GitHub pull requests. This document outlines some of the conventions related to development workflow, commit message formatting, contact points and other resources to make it easier to get your contribution accepted. ## Certificate of Origin 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](DCO) file for details. Contributors sign-off that they adhere to these requirements by adding a Signed-off-by line to commit messages. For example: ``` This is my commit message Signed-off-by: Random J Developer ``` Git even has a -s command line option to append this automatically to your commit message: ```console git commit -s -m 'This is my commit message' ``` If you have already made a commit and forgot to include the sign-off, you can amend your last commit to add the sign-off with the following command, which can then be force pushed. ```console git commit --amend -s ``` We use a [DCO bot](https://github.com/apps/dco) to enforce the DCO on each pull request and branch commits. ## Getting Started 1. Fork the repository on GitHub 1. Read the [install](INSTALL.md) document for build and test instructions 1. Play with the project, submit bugs, submit patches! ## Contribution Flow This is a rough outline of what a contributor's workflow looks like: 1. Create a branch from where you want to base your work (usually master). 1. Make your changes and arrange them in readable commits. 1. Make sure your commit messages are in the proper format (see below). 1. Push your changes to the branch in your fork of the repository. 1. Make sure all tests pass, and add any new tests as appropriate. 1. Submit a pull request to the original repository. For detailed contribution instructions, refer to the [development flow](Documentation/Contributing/development-flow.md). ## Coding Style Rook projects are written in golang and follows the style guidelines dictated by the go fmt as well as go vet tools. ## Comments Comments should be added to all new methods and structures as is appropriate for the coding language. Additionally, if an existing method or structure is modified sufficiently, comments should be created if they do not yet exist and updated if they do. The goal of comments is to make the code more readable and grokkable by future developers. Once you have made your code as understandable as possible, add comments to make sure future developers can understand (A) what this piece of code's responsibility is within Rook's architecture and (B) why it was written as it was. The below blog entry explains more the why's and how's of this guideline. https://blog.codinghorror.com/code-tells-you-how-comments-tell-you-why/ For Go, Rook follows standard godoc guidelines. A concise godoc guideline can be found here: https://blog.golang.org/godoc-documenting-go-code ## Commit Messages We follow a rough convention for commit messages that is designed to answer two questions: what changed and why. The subject line should feature the what and the body of the commit should describe the why. ```console ceph: update MON to use rocksdb this enables us to remove leveldb from the codebase. ``` The format can be described more formally as follows: ``` :