Skip to content

Commit 52e8f16

Browse files
committed
Add GitHub labels and docs format to CLAUDE.md
Document repository conventions for GitHub issue creation and documentation format to ensure consistency: - GitHub Labels: List all available labels (enhancement, bug, documentation, etc.) with instruction to only use existing labels - Documentation Format: Clarify that all user-facing docs use AsciiDoc (.adoc), not Markdown, with CLAUDE.md as the only exception These conventions will help maintain consistency in issue creation and prevent accidentally creating documentation in wrong format. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com> Introduced in the course of support-and-care/maven-support-and-care#137
1 parent 53edbbf commit 52e8f16

File tree

1 file changed

+35
-0
lines changed

1 file changed

+35
-0
lines changed

CLAUDE.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -72,6 +72,41 @@ Co-Authored-By: Claude <noreply@anthropic.com>
7272
Introduced in the course of support-and-care/maven-support-and-care#137
7373
```
7474

75+
## GitHub Issues and Documentation Conventions
76+
77+
### GitHub Labels
78+
79+
**IMPORTANT: Only use existing labels when creating issues.**
80+
81+
Available labels in this repository:
82+
- `enhancement` - New feature or request
83+
- `bug` - Something isn't working
84+
- `documentation` - Improvements or additions to documentation
85+
- `question` - Further information is requested
86+
- `help wanted` - Extra attention is needed
87+
- `good first issue` - Good for newcomers
88+
- `duplicate` - This issue or pull request already exists
89+
- `invalid` - This doesn't seem right
90+
- `wontfix` - This will not be worked on
91+
92+
To check available labels: `gh label list`
93+
94+
### Documentation Format
95+
96+
**All project documentation uses AsciiDoc format (.adoc), not Markdown.**
97+
98+
**Documentation files:**
99+
- `README.adoc` - Main repository documentation
100+
- `example_*/readme.adoc` - Per-example documentation
101+
- `.claude/transformations/*.md` - Only transformation guides use Markdown
102+
103+
**Exception:** `CLAUDE.md` is the only Markdown file in the project root (by design, for Claude Code compatibility).
104+
105+
**When creating or updating documentation:**
106+
- Use `.adoc` extension for all user-facing documentation
107+
- Follow AsciiDoc syntax (see `~/.claude/rules/asciidoc-conventions.md` for details)
108+
- Only use Markdown for internal transformation guides
109+
75110
## Transformation Workflow
76111

77112
When performing large-scale transformations or refactorings across the repository, follow this structured approach to ensure consistency and capture reusable patterns:

0 commit comments

Comments
 (0)