doc: create documentation for Conventional Commits#15
Merged
Conversation
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>
1 task
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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)
feat,fix,doc,config,refactor,agent,format,test,perfformattype has no issue template,bugvsfixterminology)/make-commit,/make-branch,/make-pr)docs/CONVENTIONAL_COMMITS.ko.md - Korean translation (489 lines)
README Updates
docs/CONVENTIONAL_COMMITS.mdin Features section and Repository Contentsdocs/CONVENTIONAL_COMMITS.ko.mdin Features section and Repository ContentsKey Features
Test
.claude/commands/.github/ISSUE_TEMPLATE/Reference
/make-commit,/make-branch,/make-prHuman Check
🤖 Generated with Claude Code