Skip to content

Comments

doc: create documentation for Conventional Commits#15

Merged
p-iknow merged 1 commit intomainfrom
i9-doc/create-documentation-for-conventional-commits
Oct 25, 2025
Merged

doc: create documentation for Conventional Commits#15
p-iknow merged 1 commit intomainfrom
i9-doc/create-documentation-for-conventional-commits

Conversation

@p-iknow
Copy link
Contributor

@p-iknow p-iknow commented Oct 25, 2025

Requirement

Resolves #9

Create comprehensive documentation for Conventional Commits that serves as the source of truth for our commit conventions, with clear guidelines on what commit formats we use, why we chose these formats, example use cases, and how they map to issue templates.

Implementation

Documentation Files Created

  • docs/CONVENTIONAL_COMMITS.md - Complete English documentation (489 lines)

    • Overview section explaining why we use Conventional Commits and link to official spec
    • Detailed documentation of all 9 commit types: feat, fix, doc, config, refactor, agent, format, test, perf
    • Each type includes: definition, when to use, examples, and anti-patterns
    • Scope usage guidelines with syntax and examples
    • Commit type to issue template mapping table
    • Real-world scenario matrix for quick reference
    • "Requirement" vs "Goal" usage guidelines
    • Current limitations section documenting gaps (format type has no issue template, bug vs fix terminology)
    • Links to custom commands that enforce conventions (/make-commit, /make-branch, /make-pr)
  • docs/CONVENTIONAL_COMMITS.ko.md - Korean translation (489 lines)

    • Full Korean translation of the documentation
    • Technical terms and code examples preserved in English
    • Explanations and guidelines translated to Korean

README Updates

  • README.md - Added link to docs/CONVENTIONAL_COMMITS.md in Features section and Repository Contents
  • README.ko.md - Added link to docs/CONVENTIONAL_COMMITS.ko.md in Features section and Repository Contents

Key Features

  • Comprehensive coverage of all 9 commit types used in the project
  • Direct mapping between commit types and issue templates
  • Real-world scenarios with matching commit examples
  • Current limitations clearly documented
  • Bilingual support (English and Korean)

Test

  • Documentation reviewed for accuracy
  • All commit types match custom commands in .claude/commands/
  • All commit types match issue templates in .github/ISSUE_TEMPLATE/
  • Links and references properly connected
  • Consistency with existing documentation maintained
  • Korean translation preserves technical terms correctly

Reference

Human Check

🤖 Generated with Claude Code

  • I reviewed it

Requirement:
Provide comprehensive documentation for commit conventions as the single source of truth, with clear guidelines on commit types, issue template mappings, and real-world scenarios. Support both English and Korean readers.

Implementation:
- Created docs/CONVENTIONAL_COMMITS.md with complete documentation
  - Documented all 9 commit types (feat, fix, doc, config, refactor, agent, format, test, perf)
  - Added scope usage guidelines and examples
  - Created commit type to issue template mapping table
  - Added real-world scenario matrix for quick reference
  - Documented current limitations and future improvements
  - Added links to custom commands that enforce conventions
- Created docs/CONVENTIONAL_COMMITS.ko.md as Korean translation
  - Preserved technical terms and code examples in English
  - Translated explanations and guidelines to Korean
- Updated README.md to link to documentation
- Updated README.ko.md to link to Korean documentation

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
@github-actions github-actions bot added the doc Documentation changes label Oct 25, 2025
@p-iknow p-iknow marked this pull request as ready for review October 25, 2025 07:33
@p-iknow p-iknow merged commit 1394236 into main Oct 25, 2025
4 checks passed
@p-iknow p-iknow deleted the i9-doc/create-documentation-for-conventional-commits branch October 25, 2025 07:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

doc Documentation changes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

doc: Create documentation for Conventional Commits

1 participant