Skip to content

Latest commit

 

History

History
30 lines (19 loc) · 1.21 KB

CONTRIBUTING.md

File metadata and controls

30 lines (19 loc) · 1.21 KB

Contributing

Welcome

Contributions are very welcome on go-utils. When contributing please keep this in mind:

  • Open an issue to discuss new bigger features.
  • Write code consistent with the project style and make sure the tests are passing.
  • Stay in touch with us if we have follow up questions or requests for further changes.

Development

Please refer to the README.md file of concrete utility for development and testing instructions.

Static checking and Linting

We use Trunk.io for static checking and linting. Install it locally and you'll be good to go.

Opening a PR

  • Commit messages should describe the changes, not the filenames. Win our admiration by following the excellent advice from Chris Beams when composing commit messages.
  • Choose a meaningful title for your pull request.
  • The pull request description should focus on what changed and why.
  • Check that the tests pass (and add test coverage for your changes if appropriate).

Commit Messages

This project adheres to the Conventional Commits specification. Please, make sure that your commit messages follow that specification.