CircleCI-Public / circleci-config-sdk-ts

Generate CircleCI Configuration YAML from JavaScript or TypeScript. Use Dynamic Configuration and the Config SDK together for live generative config.
https://circleci-public.github.io/circleci-config-sdk-ts/
Apache License 2.0
82 stars 29 forks source link

Request: Add CommitLint #77

Closed KyleTryon closed 2 years ago

KyleTryon commented 2 years ago

Is there an existing issue that is already proposing this?

Is your feature request related to a problem? Please describe it

Ensure all commits standardize to conventional commit standards. https://github.com/conventional-changelog/commitlint

Describe the solution you'd like

Add a pre-commit hook via the commit-lint npm module to validate commits. https://commitlint.js.org/#/

Teachability, documentation, adoption, migration strategy

Users will receive an error when making a new commit if conventional commit format is not followed.

What is the motivation / use case for changing the behavior?

To standardize the commit messages and make clean change-logs that can be parsed in the future.

KyleTryon commented 2 years ago

complete