Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Commitlint: Document commit scopes #27

Open
OndraM opened this issue Nov 12, 2021 · 0 comments
Open

Commitlint: Document commit scopes #27

OndraM opened this issue Nov 12, 2021 · 0 comments

Comments

@OndraM
Copy link
Member

OndraM commented Nov 12, 2021

When using commit lint, scopes on the beginning of each commit message are enforced. However, there is nowhere any documentation which scopes should be used and when.
There is only configuration file, but without further documentation. This is very bad experience for people without previous conventional commits knowledge.

There should be a clear documentation of the scopes, similarly as commitzen provide:
add-commit

(Or - we should preferably just use some common naming scheme, with slightest changes possible, and not invent our own.)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant