Skip to content

Latest commit

 

History

History
23 lines (16 loc) · 788 Bytes

CONTRIBUTING.md

File metadata and controls

23 lines (16 loc) · 788 Bytes
Raw

Contributing

Local setup for pre-commit hooks

To test hooks before commiting, you can run pre-commit run -a.

Commit guidelines

To generate changelog, Pull Requests and Commits must have semantic and must follow conventional specs below:

  • feat()!: for breaking changes (major release)
  • feat(): for new features (minor release)
  • fix(): for bug fixes (patch release)
  • docs(): for documentation and examples (no release)
  • refactor(): for code refactoring (no release)
  • test(): for tests (no release)
  • ci(): for CI purpose (no release)
  • chore(): for chores stuff (no release)

The chore prefix skipped during changelog generation. It can be used for chore: update changelog commit message by example.