Skip to main content
Glama
kzmshx
by kzmshx
CLAUDE.md3.34 kB
# CLAUDE.md ## Conventional Commits / Branch Naming | type | purpose | | ---------- | -------------------------------------------------- | | `feat` | New feature | | `fix` | Bug fix | | `docs` | Documentation only | | `style` | Changes that don't affect code meaning (whitespace, formatting) | | `refactor` | Code change that is neither a fix nor a feature | | `test` | Adding or modifying tests | | `chore` | Build process or tooling changes | Branch name: `{type}/{description}` (e.g., `feat/rename-tools`, `fix/json-encoding`) ## Development Workflow 1. Create branch (`{type}/{description}`) 2. Create `docs/workspace/{branch}/PLAN.md` 3. Review and refine PLAN.md with user before implementation 4. Implement 5. Create `NOTES_{YYYYMMDD_HHMMSS}.md` at each milestone 6. Create PR and merge ## PR Review Handling | Operation | Command | | -------------- | ------------------------------------------------------------------------------------------- | | Check CI | `gh pr checks {n}` | | Get comments | `gh api repos/{owner}/{repo}/pulls/{n}/comments` | | Reply | `gh api repos/{owner}/{repo}/pulls/{n}/comments/{comment_id}/replies -X POST -f body="..."` | Reply to comments with commit hash after fixes. ## Documentation Structure ### docs/workspace/{branch}/ Per-branch working documents. Excluded by `.gitignore`. Structure: - `PLAN.md`: Feature specification and implementation tasks - `NOTES_{YYYYMMDD_HHMMSS}.md`: Work log (findings, issues, solutions). Created at each milestone ### docs/adr/ Managed with `adr` CLI (adr-tools). Git tracked. - Create: `adr new <title>` - List: `adr list` - Supersede: `adr new -s <number> <title>` ## Documentation Rules ### Common Rules - No emojis - No horizontal rules (`---`) ### Common Style - State facts concisely - Avoid unnecessary decoration or verbose explanations (lists and tables are fine for readability) - Show concrete examples for code and config ### Security Rules (Important) Documents under `docs/` are Git tracked, so the following are prohibited: - Private keys, tokens, passwords - API keys, credentials - Personally identifiable information (names, emails, usernames) - Local environment paths (e.g., `/Users/username/`) - Project IDs and resource names are OK (e.g., `exp-batch-predictions`) - For specific config values, reference template files like `.env.example` - Local environment info should go in `CLAUDE.local.md` ### docs/workspace/{branch}/PLAN.md Rules - h1 heading should be `# PLAN` - h2, h3, h4 are allowed (avoid excessive nesting) ### docs/workspace/{branch}/NOTES_{YYYYMMDD_HHMMSS}.md Rules - Filename timestamp should use `date +%Y%m%d_%H%M%S` output directly (no modification) - h1 heading should match filename (e.g., `# NOTES_20251129_094523`) - Use only h2 headings with concise points directly below (no h3 or deeper) - Include reference links within each section

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/kzmshx/frontmatter-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server