Conventional commit message type is unstyled when description starts with inline code

[loqusion]

When a commit message is formatted according to the conventional commits style (e.g. build(main): relax `http` version requirement), GitHub normally displays the commit on github.com/<user>/<repo>/commits/<branch> by styling the <type> as a badge:

However, if the <description> starts with inline code (e.g. test(core): `SessionStore` is dyn compatible), the badge style is not applied:

This issue does not occur if <description> simply starts with a backtick: it only seems to happen if the first word is styled as inline code.

[github-actions[bot]]

💬 Your Product Feedback Has Been Submitted 🎉

Thank you for taking the time to share your insights with us! Your feedback is invaluable as we build a better GitHub experience for all our users.

Here's what you can expect moving forward ⏩

• Your input will be carefully reviewed and cataloged by members of our product teams. 
  • Due to the high volume of submissions, we may not always be able to provide individual responses.
  • Rest assured, your feedback will help chart our course for product improvements.
• Other users may engage with your post, sharing their own perspectives or experiences. 
• GitHub staff may reach out for further clarification or insight. 
  • We may 'Answer' your discussion if there is a current solution, workaround, or roadmap/changelog post related to the feedback.

Where to look to see what's shipping 👀

• Read the Changelog for real-time updates on the latest GitHub features, enhancements, and calls for feedback.
• Explore our Product Roadmap, which details upcoming major releases and initiatives.

What you can do in the meantime 💻

• Upvote and comment on other user feedback Discussions that resonate with you.
• Add more information at any point! Useful details include: use cases, relevant labels, desired outcomes, and any accompanying screenshots.

As a member of the GitHub community, your participation is essential. While we can't promise that every suggestion will be implemented, we want to emphasize that your feedback is instrumental in guiding our decisions and priorities.

Thank you once again for your contribution to making GitHub even better! We're grateful for your ongoing support and collaboration in shaping the future of our platform. ⭐

[Izalp]

Hi @loqusion!

The conventional commit pattern generally follows this structure:

<type>(<scope>): <description>

Examples:

✅ - Correctly displays the type badge:

feat(auth): add login functionality

❌ - Does not display the badge due to embedded code:

test(core): SessionStore is dyn compatible

✅ - Works fine:

test(core): `SessionStore` is dyn compatible

Possible solutions or alternatives:

1. Avoid embedded code at the beginning of the description
2. Rewrite the description so it doesn’t start with code
3. Use a single backtick or quotation marks

Example of reformulation:

# Before (problematic)  
test(core): SessionStore is dyn compatible

# After (working)  
test(core): Verify dyn compatibility of `SessionStore`

I hope I was able to help! If any more questions come up, just send them here :)

[loqusion]

Hi @Izalp,

Thanks for your response!

To clarify, I consider the behavior of not displaying <type> styled as a badge a bug if a commit is correctly formatted according to the conventional commits style. In particular, I do not consider test(core): `SessionStore` is dyn compatible to be invalid formatting just because the first word of the <description> is styled as inline code.

[Izalp]

Perfect! I completely understand. In fact, you are absolutely correct, @loqusion. The formatting test(core): SessionStore is dyn compatible is valid according to commit conventions and should not prevent the commit type from being styled as a badge.

GitHub should maintain the styling of the commit type (test in this case) regardless of how the description begins, especially if the formatting follows conventional standards.

Your observation highlights an important point about consistency in the rendering of commit metadata, where small formatting details should not interfere with the visual presentation of commit types.