Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
29 lines (19 loc) · 1.35 KB

CONTRIBUTING.md

File metadata and controls

29 lines (19 loc) · 1.35 KB

Contribution guide

Developing commitizen

You consider contributing changes to commitizen – thank you! Please consider these guidelines when filing a pull request:

  • Commits follow the Angular commit convention
  • Use wonderful Go language(>= 1.25)
  • Features and bug fixes should be covered by test cases
  • Project uses golangci-lint for code linting and formatting, both local and in CI
  • For local development usage of goenv is encouraged for zero-pain Go versions switching
  • Also for local development lefthook is used for git hooks management

For developers using VSCode all required extensions and specific project settings are provided with repo

Creating releases

commitizen uses goreleaser to release new versions from git tags.

Next version is defined and changelogs is generated by git-cliff

Commits of type fix will trigger bugfix releases, think 0.0.1\ Commits of type feat will trigger feature releases, think 0.1.0\ Commits with BREAKING CHANGE in body or footer will trigger breaking releases, think 1.0.0

Releases are created with git tags GitHub workflow. To create git tag for next release use command from Makefile

make version