claude-comms 1.0.28 → 1.0.30

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,58 @@
1
+ [AGENT OPERATING PROCEDURES]
2
+ # AOP
3
+
4
+ [CALIBRATE]
5
+ Baseline your understanding of the project current state, trajectory, guidelines. ALWAYS perform each of the following to initially orient yourself for downstream allignment:
6
+ *Read documentation*
7
+ - Read specific files referenced by the user in full to understand specific context and requirements.
8
+ - Read project guides `docs/project/guides/`, and source-of-truth (SoT) requirement specs `docs/project/spec/`, relevant to your Assignment/Task. IMPORTANT: You will need to read multiple documents, some of which may link to other relevant documents you must read. You must allign your approach with this documentation. Read the relevant documents in full!
9
+ - Read relevant phase documentation from `docs/project/phases/<phase-id>/` if working at phase/WP level
10
+ *Explore codebase*
11
+ - Broad project shape/structure understanding with Bash `tree --gitignore`
12
+ - Search codebase multiple rounds to discover patterns, dependencies, implications. You can use `ripgrep` and `ast-grep` CLI
13
+ - Read code and test files, trace impact through end to end
14
+
15
+
16
+
17
+ [IMPLEMENT]
18
+ Ensure you understand the full context, trace the target change through end to end to understand every point it touches.
19
+ feel the edges. THINK HARD about the implications/impacts
20
+ - Decision: Weigh up the implementation approach options
21
+
22
+ *Decision: If you are implementing business logic, API, workflows, or user journeys: Write Tests FIRST (Red Phase):*
23
+ - THINK HARD about the *Testing Trophy* model for your Assignment/Task. Unit = business logic, Integration = API & workflows, E2E = critical user journeys
24
+ - Map each requirement, and acceptance criterion to specific test scenarios
25
+ - Implement Tests. ensuring that the tests cover all acceptance criteria
26
+
27
+ *Implementation (Green Phase)*:
28
+ - Write minimal code to meet acceptance criteria.
29
+ - Ensure code alligns with project guides, conventions and patterns
30
+ - Refactor code for clarity, performance, maintainability
31
+
32
+
33
+
34
+ [ASSESS]
35
+ Evaluate the Change for a given Assignment/Task against the following criteria:
36
+ 1. **User Intent:** PONDER the intent of the User. Was the true intent actioned, or was it missunderstood?
37
+ 2. **Requirements Met:**
38
+ - Cross-reference the Change against relevant SoT requirements
39
+ - Verify acceptance criteria coverage and user journey completeness
40
+ 3. **Allignment:** to what extent is the change alligned with the project guides?
41
+ 4. **Quality** SOLID, DRY, design pattern, separation of concerns, complexity O(n), error handling, test coverage/pyramid
42
+
43
+
44
+
45
+ [VALIDATE]
46
+ 1. Run required commands — all must pass without warnings or errors:
47
+ - `pnpm lint`
48
+ - `pnpm ts:check`
49
+ - `pnpm test:all`
50
+ - `pnpm build`
51
+ 2. Perform manual QA:
52
+ - Use chrome-devtools MCP to manually exercise the impacted flows.
53
+ - Visually inspect any UI/UX areas touched by the change for regressions or accessibility issues.
54
+
55
+
56
+ [/AGENT OPERATING PROCEDURES]
57
+
58
+ # Repository Guidelines: see `.agents/repo.md`
@@ -0,0 +1,29 @@
1
+
2
+ # Repository Guidelines
3
+
4
+ ## Project Structure & Module Organization
5
+ - `apps/server` hosts the Bun observability API; routes stay in `src/index.ts`, persistence helpers in `src/db.ts`, and regression suites in `src/__tests__`.
6
+ - `apps/client` contains the Vue dashboard; UI modules live in `src/components` and `src/views` with Vitest and Playwright specs under `tests/`.
7
+ - `packages/setup-installer` ships the `claude-comms` NPX CLI; logic resides in `src/`, distributable templates in `templates/`, and Jest suites across `test/unit`, `test/integration`, and `test/e2e`.
8
+ - `.claude/hooks/*` stores Python-powered agents, while `scripts/` provides operational helpers such as `start-system.sh`, `reset-system.sh`, and telemetry generators.
9
+
10
+ ## Build, Test, and Development Commands
11
+ - `./scripts/start-system.sh` boots the Bun API, Vue dashboard, and SQLite broker for an end-to-end stack from the repo root.
12
+ - `cd apps/server && bun install && bun run dev` starts the API with hot reload; use `bun run start` for production parity and `bun run typecheck` before merging.
13
+ - `cd apps/client && bun install && bun run dev` launches the dashboard; `bun run build` compiles the Vite bundle and `bun run preview` smoke-tests it.
14
+ - `cd packages/setup-installer && npm install && npm test` validates the installer; run `npm run lint` or `npm run test:coverage` when altering CLI behavior or templates.
15
+
16
+ ## Coding Style & Naming Conventions
17
+ - Use 2-space indentation, `camelCase` utilities, `PascalCase` components and types, and co-locate shared shapes in `apps/*/src/types.ts`.
18
+ - Keep persistence isolated to `apps/server/src/db.ts`; expose new queries through typed helpers rather than inline SQL inside request handlers.
19
+ - In the dashboard prefer composables in `src/composables`, Tailwind utility classes, and structured logging or toast utilities instead of raw `console.log` calls.
20
+
21
+ ## Testing Guidelines
22
+ - Backend suites live in `apps/server/src/__tests__` with `.test.ts` suffixes; run `bun run test` or `bun run test:coverage` whenever mutating server logic.
23
+ - Dashboard coverage pairs Vitest (`bun run test`) with Playwright smoke tests in `apps/client/tests/playwright`; refresh artifacts in `tests/visual` when UI states change.
24
+ - Installer validation relies on Jest; execute `npm run test:integration` after template edits and `npm run test:e2e` before publishing new packages.
25
+
26
+ ## Commit & Pull Request Guidelines
27
+ - History favors short, imperative subjects (`remove matrix mode`) with selective conventional prefixes (`chore(release): 1.0.23`); follow that tone and omit trailing periods.
28
+ - Reference issues and describe agent-facing impact in PR descriptions; attach dashboard screenshots or installer logs whenever UX or setup flows shift.
29
+ - Before requesting review, ensure `./scripts/test-system.sh` plus relevant package checks pass and call out skipped suites or follow-up tasks in the PR notes.
@@ -162,7 +162,7 @@ IMPORTANT: What is your DocScope?
162
162
 
163
163
  🤝 Batch an Inbox Check with every read/write/tool action, and dynamically add TEAMWORK Broadcast as per Communication Protocols 🤝
164
164
 
165
- 1. Consume AGENT OPERATING PROCEDURES (AOP) `AGENTS.md`. *You will execute 1 or more of Procedures in the following steps*
165
+ 1. Consume AGENT OPERATING PROCEDURES (AOP) `.agents/AGENTS.md`. *You will execute 1 or more of Procedures in the following steps*
166
166
  2. Execute AOP.CALIBRATE
167
167
 
168
168
 
@@ -51,7 +51,7 @@ Populate your initial plan with your step by step WORKFLOW:
51
51
  [WORKFLOW]
52
52
  🤝 Periodically Inbox Check after every few action, and dynamically add TEAMWORK Broadcast as per Communication Protocols 🤝
53
53
 
54
- 1. Consume AGENT OPERATING PROCEDURES (AOP) `AGENTS.md`. *You will execute 1 or more of Procedures in the following steps*
54
+ 1. Consume AGENT OPERATING PROCEDURES (AOP) `.agents/AGENTS.md`. *You will execute 1 or more of Procedures in the following steps*
55
55
  2. ALWAYS Execute AOP.CALIBRATE
56
56
  3. *Decision:* Based on your Assignment/Task/Loop you may be either Implementing New, Assessing Only, or Review+Refine Existing. Choose your path accordingly:
57
57
  - *Implementing New:* Execute AOP.IMPLEMENT
@@ -31,7 +31,7 @@ Populate your initial Todos with your step by step WORKFLOW:
31
31
  [WORKFLOW]
32
32
  🤝 Batch an Inbox Check with every read/write/tool action, and dynamically add TEAMWORK Broadcast as per Communication Protocols 🤝
33
33
 
34
- 1. Consume AGENT OPERATING PROCEDURES (AOP) `AGENTS.md`. *You will execute 1 or more of Procedures in the following steps*
34
+ 1. Consume AGENT OPERATING PROCEDURES (AOP) `.agents/AGENTS.md`. *You will execute 1 or more of Procedures in the following steps*
35
35
  2. Execute AOP.CALIBRATE
36
36
  3. *Decision:* Based on your Assignment/Task/Loop you may be either Implementing New, Assessing Only, or Review+Refine Existing. Choose your path accordingly:
37
37
  - *Implementing New:* Execute AOP.IMPLEMENT
@@ -111,7 +111,7 @@ Populate your initial Todos with your step by step WORKFLOW:
111
111
  [WORKFLOW]
112
112
  🤝 Batch an Inbox Check with every read/write/tool action, and dynamically add TEAMWORK Broadcast as per Communication Protocols 🤝
113
113
 
114
- 1. Consume AGENT OPERATING PROCEDURES (AOP) `AGENTS.md`. *You will execute 1 or more of Procedures in the following steps*
114
+ 1. Consume AGENT OPERATING PROCEDURES (AOP) `.agents/AGENTS.md`. *You will execute 1 or more of Procedures in the following steps*
115
115
  2. Execute AOP.CALIBRATE
116
116
  3. **Scope Determination & Phase Definition**
117
117
  - Determine working scope: Project-level roadmap OR Phase-level WP breakdown
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "claude-comms",
3
- "version": "1.0.28",
3
+ "version": "1.0.30",
4
4
  "description": "NPX installer for Claude Code hooks and observability setup",
5
5
  "main": "src/index.js",
6
6
  "bin": {
@@ -79,8 +79,8 @@
79
79
  "README.md",
80
80
  "CHANGELOG.md",
81
81
  ".claude/",
82
- "CLAUDE.md",
83
- "AGENTS.md"
82
+ ".agents/",
83
+ "CLAUDE.md"
84
84
  ],
85
85
  "publishConfig": {
86
86
  "access": "public"
package/AGENTS.md DELETED
@@ -1,86 +0,0 @@
1
- [AGENT OPERATING PROCEDURES]
2
- # AOP
3
-
4
- [CALIBRATE]
5
- Baseline your understanding of the project current state, trajectory, guidelines. ALWAYS perform each of the following to initially orient yourself for downstream allignment:
6
- *Read documentation*
7
- - Read specific files referenced by the user in full to understand specific context and requirements.
8
- - Read project guides `docs/project/guides/`, and source-of-truth (SoT) requirement specs `docs/project/spec/`, relevant to your Assignment/Task. IMPORTANT: You will need to read multiple documents, some of which may link to other relevant documents you must read. You must allign your approach with this documentation. Read the relevant documents in full!
9
- - Read relevant phase documentation from `docs/project/phases/<phase-id>/` if working at phase/WP level
10
- *Explore codebase*
11
- - Broad project shape/structure understanding with Bash `tree --gitignore`
12
- - Search codebase multiple rounds to discover patterns, dependencies, implications. You can use `ripgrep` and `ast-grep` CLI
13
- - Read code and test files, trace impact through end to end
14
-
15
-
16
-
17
- [IMPLEMENT]
18
- Ensure you understand the full context, trace the target change through end to end to understand every point it touches.
19
- feel the edges. THINK HARD about the implications/impacts
20
- - Decision: Weigh up the implementation approach options
21
-
22
- *Decision: If you are implementing business logic, API, workflows, or user journeys: Write Tests FIRST (Red Phase):*
23
- - THINK HARD about the *Testing Trophy* model for your Assignment/Task. Unit = business logic, Integration = API & workflows, E2E = critical user journeys
24
- - Map each requirement, and acceptance criterion to specific test scenarios
25
- - Implement Tests. ensuring that the tests cover all acceptance criteria
26
-
27
- *Implementation (Green Phase)*:
28
- - Write minimal code to meet acceptance criteria.
29
- - Ensure code alligns with project guides, conventions and patterns
30
- - Refactor code for clarity, performance, maintainability
31
-
32
-
33
-
34
- [ASSESS]
35
- Evaluate the Change for a given Assignment/Task against the following criteria:
36
- 1. **User Intent:** PONDER the intent of the User. Was the true intent actioned, or was it missunderstood?
37
- 2. **Requirements Met:**
38
- - Cross-reference the Change against relevant SoT requirements
39
- - Verify acceptance criteria coverage and user journey completeness
40
- 3. **Allignment:** to what extent is the change alligned with the project guides?
41
- 4. **Quality** SOLID, DRY, design pattern, separation of concerns, complexity O(n), error handling, test coverage/pyramid
42
-
43
-
44
-
45
- [VALIDATE]
46
- 1. Run required commands — all must pass without warnings or errors:
47
- - `pnpm lint`
48
- - `pnpm ts:check`
49
- - `pnpm test:all`
50
- - `pnpm build`
51
- 2. Perform manual QA:
52
- - Use chrome-devtools MCP to manually exercise the impacted flows.
53
- - Visually inspect any UI/UX areas touched by the change for regressions or accessibility issues.
54
-
55
-
56
- [/AGENT OPERATING PROCEDURES]
57
- - Broadcast API contracts, interfaces, or significant design decisions
58
-
59
- # Repository Guidelines
60
-
61
- ## Project Structure & Module Organization
62
- - `apps/server` hosts the Bun observability API; routes stay in `src/index.ts`, persistence helpers in `src/db.ts`, and regression suites in `src/__tests__`.
63
- - `apps/client` contains the Vue dashboard; UI modules live in `src/components` and `src/views` with Vitest and Playwright specs under `tests/`.
64
- - `packages/setup-installer` ships the `claude-comms` NPX CLI; logic resides in `src/`, distributable templates in `templates/`, and Jest suites across `test/unit`, `test/integration`, and `test/e2e`.
65
- - `.claude/hooks/*` stores Python-powered agents, while `scripts/` provides operational helpers such as `start-system.sh`, `reset-system.sh`, and telemetry generators.
66
-
67
- ## Build, Test, and Development Commands
68
- - `./scripts/start-system.sh` boots the Bun API, Vue dashboard, and SQLite broker for an end-to-end stack from the repo root.
69
- - `cd apps/server && bun install && bun run dev` starts the API with hot reload; use `bun run start` for production parity and `bun run typecheck` before merging.
70
- - `cd apps/client && bun install && bun run dev` launches the dashboard; `bun run build` compiles the Vite bundle and `bun run preview` smoke-tests it.
71
- - `cd packages/setup-installer && npm install && npm test` validates the installer; run `npm run lint` or `npm run test:coverage` when altering CLI behavior or templates.
72
-
73
- ## Coding Style & Naming Conventions
74
- - Use 2-space indentation, `camelCase` utilities, `PascalCase` components and types, and co-locate shared shapes in `apps/*/src/types.ts`.
75
- - Keep persistence isolated to `apps/server/src/db.ts`; expose new queries through typed helpers rather than inline SQL inside request handlers.
76
- - In the dashboard prefer composables in `src/composables`, Tailwind utility classes, and structured logging or toast utilities instead of raw `console.log` calls.
77
-
78
- ## Testing Guidelines
79
- - Backend suites live in `apps/server/src/__tests__` with `.test.ts` suffixes; run `bun run test` or `bun run test:coverage` whenever mutating server logic.
80
- - Dashboard coverage pairs Vitest (`bun run test`) with Playwright smoke tests in `apps/client/tests/playwright`; refresh artifacts in `tests/visual` when UI states change.
81
- - Installer validation relies on Jest; execute `npm run test:integration` after template edits and `npm run test:e2e` before publishing new packages.
82
-
83
- ## Commit & Pull Request Guidelines
84
- - History favors short, imperative subjects (`remove matrix mode`) with selective conventional prefixes (`chore(release): 1.0.23`); follow that tone and omit trailing periods.
85
- - Reference issues and describe agent-facing impact in PR descriptions; attach dashboard screenshots or installer logs whenever UX or setup flows shift.
86
- - Before requesting review, ensure `./scripts/test-system.sh` plus relevant package checks pass and call out skipped suites or follow-up tasks in the PR notes.