github.com/openebs/node-disk-manager@v1.9.1-0.20230225014141-4531f06ffa1e/code-standard.md (about)

     1  # Code Standards
     2  
     3  ## Sign your commits
     4  
     5  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](https://github.com/openebs/openebs/blob/main/contribute/developer-certificate-of-origin). If you can certify it, then just add a line to every git commit message:
     6  
     7  ````
     8    Signed-off-by: Random J Developer <random@developer.example.org>
     9  ````
    10  
    11  Use your real name (sorry, no pseudonyms or anonymous contributions). The email id should match the email id provided in your GitHub profile.
    12  If you set your `user.name` and `user.email` in git config, you can sign your commit automatically with `git commit -s`.
    13  
    14  ## Verifying code style
    15  
    16  We use `go fmt` to format and follow the coding style.
    17  ```sh
    18  make fmt
    19  ```
    20  
    21  ## Adding a changelog
    22  If PR is about adding a new feature or bug fixes then Authors of the PR are expected to add a changelog file with their pull request. This changelog file should be a new file created under `changelogs/unreleased` folder. Name of this file must be in in `pr_number-username` format and contents of the file should be the one liner text which explain the feature or bug fix.
    23  
    24  ```sh
    25  node-disk-manager/changelogs/unreleased   <- folder
    26      12-github_user_name            <- file
    27  ```