Skip to content

docs(readme): improve structure and add missing content#60

Merged
kcenon merged 4 commits into
mainfrom
docs/issue-47-extract-common-policy
Jan 19, 2026
Merged

docs(readme): improve structure and add missing content#60
kcenon merged 4 commits into
mainfrom
docs/issue-47-extract-common-policy

Conversation

@kcenon

@kcenon kcenon commented Jan 19, 2026

Copy link
Copy Markdown
Owner

Summary

  • Add version badges (version, license, CI status) to both README files
  • Add Quick Start section at the top for better first-time user experience
  • Add Global Commands section documenting /branch-cleanup, /release, /issue-create, /issue-work, /pr-work
  • Update Structure section with global/commands/ directory
  • Apply collapsible sections to Structure, Skills details, and Advanced Usage
  • Update version to 1.3.0 and add v1.2.0/v1.3.0 changelog entries
  • Sync Korean README (README.ko.md) with all English README changes

Test plan

  • Verify badges render correctly on GitHub
  • Verify collapsible sections work properly
  • Verify all internal links work
  • Compare English and Korean README for consistency

- Create global/commands/_policy.md with common rules for:
  - Output language (English for git/GitHub content)
  - Attribution (no Claude/AI references)
  - Formatting (emojis forbidden, conventional commits)
  - Issue linking and build verification

- Create project/.claude/commands/_policy.md with common rules for:
  - Output format (markdown tables, code blocks)
  - Error reporting standards
  - Code analysis standards
  - Attribution policy
- Replace inline policy tables with reference to _policy.md
- Keep only command-specific rules in each file
- Reduces policy duplication across 5 global commands
- Add Policies section referencing _policy.md to all project commands
- Ensures consistent policy application across project commands
- Add version badges (version, license, CI status)
- Add Quick Start section at the top for better UX
- Add Global Commands section documenting 5 new commands
- Update Structure section with global/commands/ directory
- Apply collapsible sections to reduce visual clutter
- Update version to 1.3.0 and add changelog entries
- Sync Korean README with English version
@kcenon kcenon merged commit def2a37 into main Jan 19, 2026
@kcenon kcenon deleted the docs/issue-47-extract-common-policy branch January 19, 2026 08:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant