Lead with an example on website #20

Closed
opened 2026-02-17 11:33:15 -06:00 by GiteaMirror · 2 comments
Owner

Originally created by @patcon on GitHub (Apr 9, 2018).

The website currently has nothing above the fold that helps someone quickly know how to confirm. The spec is really rad an specific, but I feel that when a PR fails due to not conforming, it would be a really great experience if I went straight to the website and felt like "ooooooh, I get it!" The the template-speak is helpful, a prominent example above the fold could really convey the MVP of what a conventional commit is :)

Thanks for your attention and consideration! If you have a favourite commit message that meets the spec and exercises it the a proper extent, pls do drop it, and I'll submit a PR 🎉

Originally created by @patcon on GitHub (Apr 9, 2018). The website currently has nothing above the fold that helps someone quickly know how to confirm. The spec is really rad an specific, but I feel that when a [PR fails due to not conforming](https://github.com/chaijs/chaijs.github.io/pull/169), it would be a really great experience if I went straight to the website and felt like "ooooooh, I get it!" The the template-speak is helpful, a prominent example above the fold could really convey the MVP of what a conventional commit is :) Thanks for your attention and consideration! If you have a favourite commit message that meets the spec and exercises it the a proper extent, pls do drop it, and I'll submit a PR 🎉
Author
Owner

@damianopetrungaro commented on GitHub (Apr 9, 2018):

Issue #21 is going to add some example.

@damianopetrungaro commented on GitHub (Apr 9, 2018): Issue #21 is going to add some example.
Author
Owner

@patcon commented on GitHub (Apr 9, 2018):

Ah, sorry, skimmed issues, but forget to check open PR. Thanks @damianopetrungaro!

@patcon commented on GitHub (Apr 9, 2018): Ah, sorry, skimmed issues, but forget to check open PR. Thanks @damianopetrungaro!
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: github-starred/conventionalcommits.org#20