[PR #653] [CLOSED] docs: add LLM reference guide for conventional commits #636

New Issue

GiteaMirror · 2026-02-17T12:10:37-06:00

GiteaMirror commented

2026-02-17 12:10:37 -06:00

📋 Pull Request Information

Original PR: https://github.com/conventional-commits/conventionalcommits.org/pull/653
Author: @hbeneke
Created: 6/3/2025
Status: ❌ Closed

Base: master ← Head: master

📝 Commits (1)

44f76a5 docs: add LLM reference guide for conventional commits

📊 Changes

1 file changed (+165 additions, -0 deletions)

View changed files

➕ conventional-commits-reference.md (+165 -0)

📄 Description

Background

As a developer, I frequently use the Conventional Commits specification as a project prompt when working with LLM agents to generate commit messages. However, the current webpage format, while excellent for human readers, is not optimized for language model consumption.

Problem

The original webpage contains navigational elements, styling, and formatting that can confuse LLMs
Information is scattered across different sections making it harder for agents to parse
No clear validation rules summary for quick reference
Examples are interspersed throughout the text rather than grouped logically

Solution

This reference file provides:

Structured format: Clear hierarchical organization optimized for LLM parsing
Comprehensive coverage: All specification rules, examples, and edge cases in one place
Quick reference sections: Validation rules summary and SemVer integration table
Practical examples: Grouped by complexity and use case
Implementation notes: Technical details for tool developers

Benefits

Agents can now generate more accurate conventional commits
Faster parsing and understanding by LLMs
Reduces token usage compared to feeding the entire webpage
Serves as a complete reference for both humans and AI systems

This file will help developers who use LLM agents for commit message generation get more consistent and specification-compliant results.**

_{🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.}

## 📋 Pull Request Information **Original PR:** https://github.com/conventional-commits/conventionalcommits.org/pull/653 **Author:** [@hbeneke](https://github.com/hbeneke) **Created:** 6/3/2025 **Status:** ❌ Closed **Base:** `master` ← **Head:** `master` --- ### 📝 Commits (1) - [`44f76a5`](https://github.com/conventional-commits/conventionalcommits.org/commit/44f76a5835de662940cf5d4d6b0fed93dd8c3c72) docs: add LLM reference guide for conventional commits ### 📊 Changes **1 file changed** (+165 additions, -0 deletions) <details> <summary>View changed files</summary> ➕ `conventional-commits-reference.md` (+165 -0) </details> ### 📄 Description ## Background As a developer, I frequently use the Conventional Commits specification as a project prompt when working with LLM agents to generate commit messages. However, the current webpage format, while excellent for human readers, is not optimized for language model consumption. ## Problem - The original webpage contains navigational elements, styling, and formatting that can confuse LLMs - Information is scattered across different sections making it harder for agents to parse - No clear validation rules summary for quick reference - Examples are interspersed throughout the text rather than grouped logically ## Solution This reference file provides: - **Structured format**: Clear hierarchical organization optimized for LLM parsing - **Comprehensive coverage**: All specification rules, examples, and edge cases in one place - **Quick reference sections**: Validation rules summary and SemVer integration table - **Practical examples**: Grouped by complexity and use case - **Implementation notes**: Technical details for tool developers ## Benefits - Agents can now generate more accurate conventional commits - Faster parsing and understanding by LLMs - Reduces token usage compared to feeding the entire webpage - Serves as a complete reference for both humans and AI systems This file will help developers who use LLM agents for commit message generation get more consistent and specification-compliant results.** --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>

GiteaMirror added the pull-request label 2026-02-17 12:10:37 -06:00

GiteaMirror closed this issue

2026-02-17 12:10:37 -06:00

Sign in to join this conversation.

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: github-starred/conventionalcommits.org#636