Skip to content

Latest commit

 

History

History
30 lines (19 loc) · 1.24 KB

CONTRIBUTING.md

File metadata and controls

30 lines (19 loc) · 1.24 KB
Raw

Contributing

First off, thank you so much for taking the time to contribute. All contributions are more than welcome!

How can I contribute?

If you have an awesome new feature that you want to implement or you found a bug that you would like to fix, here are some instructions to guide you through the process:

  • Fork the repo
  • Clone the repo and set it up (check out the manual installation section in README.md)
  • Implement the necessary changes
  • Create tests to keep the code coverage high
  • Send a pull request

Guidelines

Git commit messages

Follow the Conventional Commits specification for clear and structured commit messages, here are the key guidelines:

  • Limit the subject line to 80 characters
  • Capitalize the first letter of the subject line
  • Use the present tense ("Add feature" instead of "Added feature")
  • Separate the subject from the body with a blank line

Coding style guide

We are using golangci-lint to ensure consistent coding standards in this project.

Please make sure that the code you are pushing conforms to the style guides mentioned above.