escapedcat
commented
1 week ago A "correct" commit depends on the configuration.
I think the examples assume you're using https://www.conventionalcommits.org
Did you find this resource? Did it help? Did the animated example help?
When did you find a helpful example?
What would you like to have seen?
Wanna create a PR?
Expected Behavior
I expect one of these pages to have examples of default acceptable commits:
https://commitlint.js.org/guides/getting-started.html (only install and setting up a config)
https://commitlint.js.org/guides/local-setup.html (only shows failing commit messages)
https://commitlint.js.org/reference/examples.html (this one is called "Examples" and yet there are no examples except of lint configuration)
The best I found was https://commitlint.js.org/concepts/commit-conventions.html but you have to expand a "Conventions" tab to find a link to a third-party website to see conventions. And It's not clear to me that "conventions" is where I would find information about ideal commit messages.
Current Behavior
I wanted to read about this package and the types of commits it enforces. I've been clicking around the docs and website and have yet to find actual commit examples.
There's plenty about setting up configs, how to share configs, etc., but no examples of commits. If they exist, they aren't easy to find.
Affected packages
Possible Solution
Improve docs to have example commit messages that are acceptable with commitment's defaults
Context
I spent ten minutes trying to find a single example of an ideal commit on the website so I could test out commitment and failed