Skip to content

Latest commit

 

History

History
30 lines (22 loc) · 1.58 KB

CONTRIBUTING.md

File metadata and controls

30 lines (22 loc) · 1.58 KB
Raw

Contributing

When contributing to this repository, please ensure that your Pull Request is linked to an issue, and that the issue is tagged with the appropriate labels (e.g. bug, enhancement, etc.). This will help us to keep track of the changes and discuss them.

Please note we have a code of conduct, please follow it in all your interactions with the project.

Pull Request Process

Firstly, thank you for contributing to this repository. Please ensure that you gather the following requirements to contribute:

  1. Ensure that the Pull Request is linked to an issue.
  2. Ensure that the issue is tagged with the appropriate labels (e.g. bug, enhancement, etc.) and prefix your Pull Request with the domain of the issue (e.g. bugfix, enhancement, etc.).
  3. Ensure that you only include one commit in your Pull Request. If you have multiple commits, please squash them into one commit.
  4. Ensure you sign your commits. See Signing your commits for more information.
  5. Ensure that you have updated the documentation and the tests to reflect your changes.
  6. Run the tests to ensure that your changes do not break any existing tests.
  7. Ensure that your code is formatted using gofmt and linted using golint.
  8. Prepare a Pull Request with the following information:
    • A description of the changes you have made.
    • A link to the issue you are fixing.

Signing your commits

To sign your commits, just add the -s flag when you commit. This will add a Signed-off-by line to your commit message. For example:

git commit -s -m "This is my commit message"