Skip to content

Commit 1f5cc4e

Browse files
sarg3ntclaude
andcommitted
chore: dedupe shared rules into user-global CLAUDE.md
The "Branch Naming Convention", "PR Convention", "Issue Labels", "Code Block Formatting", and "Markdown Linting" sections were generic preferences duplicated across homelab, gearbox, and ubuntu-ha-proxy-install. They've been promoted to ~/.claude/CLAUDE.md. What remains here is the gearbox-specific scaffolding around them: the GitHub-driven workflow steps (issues + project board), the gearbox project ID and board configuration, the docs/reports/ convention, and the TOC-after-heading note for new docs. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
1 parent bc07b89 commit 1f5cc4e

1 file changed

Lines changed: 4 additions & 33 deletions

File tree

CLAUDE.md

Lines changed: 4 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -102,26 +102,9 @@ When a new feature is planned or a bug is reported:
102102
7. **Track Progress** — Keep the project board and issues in sync
103103
8. **Complete** — When user confirms done: merge PR, close issue, move project card to Done
104104

105-
### Branch Naming Convention
105+
### Branching, PR, and label conventions
106106

107-
- **Features:** `feature/short-description` (e.g., `feature/dashboard-export`)
108-
- **Bug fixes:** `fix/short-description` (e.g., `fix/websocket-reconnect`)
109-
- **Always branch from `main`**
110-
111-
### PR Convention
112-
113-
- All PRs target `main`
114-
- PR body must include `Closes #<issue-number>` to auto-close the issue on merge
115-
- Use the standard PR template format (Summary, Test Plan)
116-
117-
### Issue Labels
118-
119-
Use these labels consistently:
120-
121-
- `enhancement` — New features
122-
- `bug` — Bug fixes
123-
- `documentation` — Docs-only changes
124-
- `refactor` — Code improvements without behavior change
107+
Generic branching/PR/label rules live in `~/.claude/CLAUDE.md`. All of them apply here unmodified — `feature/...` and `fix/...` branches from `main`, `Closes #N` in PR bodies, the four standard labels.
125108

126109
### Project Board
127110

@@ -151,14 +134,6 @@ TASKS.md is a **scratch pad only** — not a tracking system. The GitHub Project
151134
- `/dowork` - Read TASKS.md, create issues from it, and start working (ask questions as needed)
152135
- `/doallwork` - Read TASKS.md, create issues from it, and work autonomously
153136

154-
## User Preferences
155-
156-
### Code Block Formatting
157-
158-
- **Always use fenced code blocks** (triple backticks) for commands
159-
- Fenced blocks provide a copy button in the IDE
160-
- Never use inline code for commands the user should run
161-
162137
## UI Conventions
163138

164139
### Modal dialogs — never use native `confirm()`, `alert()`, or `prompt()`
@@ -241,13 +216,9 @@ import "github.com/sarg3nt/gearbox/internal/framework/ui"
241216
- Inform user before running `make deploy` for agent
242217
- Validate HAProxy config with `haproxy -c` before reload (if applicable)
243218

244-
### Markdown Linting
245-
246-
Run `npx markdownlint-cli '**/*.md' --config .markdownlint.json` to validate. Key rules: blank lines around lists/code blocks, specify language for code blocks, proper headings, single newline at EOF.
247-
248-
### Creating New Documentation
219+
### Markdown and docs
249220

250-
Store in `docs/` directory using kebab-case naming. Include TOC after main heading. Reference in README.md.
221+
See `~/.claude/CLAUDE.md` for markdown style and the `docs/` + kebab-case rule. This repo also requires a TOC after the main heading in new docs.
251222

252223
### Creating Reports and Scan Results
253224

0 commit comments

Comments
 (0)