Skip to content

Latest commit

 

History

History
33 lines (25 loc) · 1.61 KB

code-standard.md

File metadata and controls

33 lines (25 loc) · 1.61 KB
Raw

Code Standards

Sign your commits

We use the Developer Certificate of Origin (DCO) as an additional safeguard for the OpenEBS projects. This is a well established and widely used mechanism to assure that contributors have confirmed their right to license their contribution under the project's license. Please read dcofile. If you can certify it, then just add a line to every git commit message:

  Signed-off-by: Random J Developer <[email protected]>

Use your real name (sorry, no pseudonyms or anonymous contributions). The email id should match the email id provided in your GitHub profile. If you set your user.name and user.email in git config, you can sign your commit automatically with git commit -s.

Verifying code style

Code style can be verified using make cstyle

Adding a changelog

If PR is about adding a new feature or bug fixe then the Author of the PR is expected to add a changelog file with their pull request. This changelog file should be a new file created under the changelogs/unreleased folder. Name of this file must be in pr_number-username format and contents of the file should be the one-liner text which explains the feature or bug fix.

cstor/changelogs/unreleased   <- folder
    12-github_user_name            <- file

For example, if xyz user has raised a PR 16 to add support for snapshot destroy then channgelog file name will be

cstor/changelogs/unreleased/16-xyz

and content of the file will be

adding support for snapshot destroy