Skip to content

Commit 4d67a00

Browse files
Merge pull request #3165 from pierreb-devkit/docs/condense-ai-instruction-files
docs(ai): condense AI instruction files, remove duplication
2 parents 762c79a + 6f1c83b commit 4d67a00

File tree

5 files changed

+6
-68
lines changed

5 files changed

+6
-68
lines changed

.claude/agents/stack-maintainer.md

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -41,10 +41,3 @@ You are the stack maintainer agent. Your role is to protect the mergeability and
4141
- Don't write code
4242
- Keep reviews short and focused
4343

44-
## Example review
45-
46-
```
47-
🔴 Critical: `.env` file was modified (should be git-ignored)
48-
🟡 Warning: Controller imports repository directly — must go through service layer
49-
🟢 Info: Consider extracting this validation schema to `lib/helpers/joi.js` for reuse
50-
```

.github/copilot-instructions.md

Lines changed: 1 addition & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -7,16 +7,7 @@
77

88
## Canonical commands
99

10-
- Dev: `npm start` (alias: `npm run dev`)
11-
- Debug: `npm run debug`
12-
- Tests: `npm test` / `npm run test:unit` (one-shot) or `npm run test:watch` (watch)
13-
- Coverage: `npm run test:coverage`
14-
- Lint: `npm run lint`
15-
- Lint fix: `npm run lint:fix`
16-
- Format: `npm run format`
17-
- Seed: `npm run seed:dev`
18-
- Commit: `npm run commit`
19-
- Release (CI): `npm run release:auto`
10+
Scripts: see `package.json``scripts` section.
2011

2112
## Available prompts
2213

AGENTS.md

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,6 @@ For architecture, modularity rules, guardrails, naming, commands, and definition
99
- Keep changes secure and free of secrets
1010
- Enforce module boundaries and layered architecture
1111

12-
## Preflight
13-
14-
- Read `ERRORS.md` before proposing changes or code reviews
15-
- If the AI makes a new recurring mistake, append one line to `ERRORS.md` using `[YYYY-MM-DD] <scope>: <wrong> -> <right>`
16-
1712
## Codex prompt routing
1813

1914
Use `.github/prompts/*` as task playbooks:
@@ -27,8 +22,3 @@ Use `.github/prompts/*` as task playbooks:
2722
| Naming | `.github/prompts/naming.prompt.md` |
2823
| PR | `.github/prompts/pull-request.prompt.md` |
2924

30-
## Review output convention
31-
32-
- `Critical`: must fix before merge (security, breakage, mergeability risk)
33-
- `Warning`: should be reviewed (coupling, architecture drift)
34-
- `Info`: non-blocking suggestion

CLAUDE.md

Lines changed: 2 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -12,24 +12,7 @@ The `.claude/` folder contains embedded settings, skills, and agents that are av
1212

1313
## Canonical commands
1414

15-
| Command | Script | Description |
16-
| ---------------- | ------------------------ | ---------------------------------------------- |
17-
| **Dev** | `npm start` | Start dev server at `http://localhost:3000/` |
18-
| **Dev (alias)** | `npm run dev` | Alias for `npm start` |
19-
| **Debug** | `npm run debug` | Start with nodemon and inspector |
20-
| **Prod** | `npm run prod` | Start in production mode |
21-
| **Test** | `npm test` | Run all tests (one-shot) |
22-
| **Unit test** | `npm run test:unit` | Run unit tests once (alias of `npm test`) |
23-
| **Watch** | `npm run test:watch` | Run tests in watch mode |
24-
| **Coverage** | `npm run test:coverage` | Generate test coverage |
25-
| **Lint** | `npm run lint` | Check code quality |
26-
| **Lint fix** | `npm run lint:fix` | Auto-fix linting issues |
27-
| **Format** | `npm run format` | Format with Prettier |
28-
| **Seed** | `npm run seed:dev` | Seed development database |
29-
| **Commit** | `npm run commit` | Commit with commitizen |
30-
| **Release** | `npm run release` | Manual release (standard-version) |
31-
| **Release (CI)** | `npm run release:auto` | Semantic release for CI |
32-
| **Docker** | `docker-compose up` | Start with docker-compose |
15+
Scripts: see `package.json``scripts` section.
3316

3417
## Preflight
3518

@@ -75,13 +58,7 @@ Use `.claude/skills/*/SKILL.md` as the primary workflow source for Claude.
7558

7659
## Stack merge workflow
7760

78-
```bash
79-
git remote add devkit-node https://github.com/pierreb-devkit/Node.git
80-
git fetch devkit-node
81-
git merge devkit-node/master
82-
```
83-
84-
Resolve conflicts carefully to preserve downstream customizations and keep future merges clean.
61+
See README — stack merge workflow section.
8562

8663
## Definition of done
8764

README.md

Lines changed: 3 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -153,22 +153,7 @@ This stack ships preconfigured instruction and prompt files for Claude Code, Git
153153

154154
### Claude Code — Available Skills
155155

156-
| Skill | Description |
157-
| ---------------- | ----------------------------------------------------- |
158-
| `/verify` | Run quality loop (lint + tests) |
159-
| `/create-module` | Create new module by duplicating the `tasks` template |
160-
| `/feature` | Implement feature following layered architecture rules |
161-
| `/update-stack` | Merge stack updates into downstream projects |
162-
| `/naming` | Check or apply file and folder naming conventions |
163-
| `/pull-request` | Full PR lifecycle: branch, commit, issue, monitor |
164-
165-
### Layered Architecture Rules
166-
167-
- Layer order is strict: **Routes → Controllers → Services → Repositories → Models**
168-
- Controllers must not call repositories directly — always go through services
169-
- Each module is self-contained in `modules/{name}/`
170-
- Shared code goes in `lib/helpers/` or `lib/services/` with explicit justification
171-
- Tests are organized per module: `modules/*/tests/`
156+
Skills available via `/verify`, `/feature`, `/create-module`, `/update-stack`, `/naming`, `/pull-request` — see `.claude/skills/` for details.
172157

173158
### Stack Merge Workflow
174159

@@ -178,6 +163,8 @@ git fetch devkit-node
178163
git merge devkit-node/master
179164
```
180165

166+
> Caution: resolve conflicts manually to preserve downstream customizations before pushing.
167+
181168
## :pencil2: Contribute
182169

183170
Open issues and pull requests on [GitHub](https://github.com/pierreb-devkit/Node).

0 commit comments

Comments
 (0)