Thank you for taking the time to contribute! This project welcomes both issues and pull requests.
- Search the existing issues before filing a new one.
- Include a clear description of the problem or suggestion.
- Provide steps to reproduce bugs when applicable.
- Fork the repository and create your feature branch off of
main:git checkout -b feature/my-change
- Follow the coding standards described below.
- Commit your changes with a meaningful commit message.
- Push the branch and open a pull request against
mainon GitHub.
- All Go code should be formatted with
go fmt. - Keep functions small and focused.
- Add unit tests where possible.
Use descriptive branch names prefixed with the type of change:
feature/for new featuresbugfix/for bug fixesdocs/for documentation changes
Example:
feature/add-cache-support- Use the imperative mood in the subject line ("Add feature" not "Added feature").
- Limit the subject line to 72 characters.
- Use the body to explain why the change was made, not just what was done.