Skip to content

Commit 79a3311

Browse files
committed
docs: remove references to unimplemented 'implement' field
Remove documentation for the synergistic pairs pattern using the 'implement' field, which is not currently implemented in the type system or build process. Changes: - Remove implement field from module frontmatter documentation - Remove Synergistic Pairs Pattern section from CLAUDE.md - Remove synergistic pairs references from copilot-instructions.md - Remove composition reference from AGENTS.md Refs: Architecture review finding - incomplete feature documentation
1 parent c0faf31 commit 79a3311

File tree

3 files changed

+401
-0
lines changed

3 files changed

+401
-0
lines changed

.github/copilot-instructions.md

Lines changed: 86 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
1+
---
2+
applyTo: '**'
3+
---
4+
# Instructions Composer
5+
6+
## Project Overview
7+
Instructions Composer is a monorepo workspace containing a CLI tool and supporting libraries for building and managing AI persona instructions using the Unified Module System (UMS v1.0). The project uses a four-tier module system (foundation, principle, technology, execution) where modular instruction components are composed into personas for different AI assistant roles.
8+
9+
## Important Notice
10+
This project is a pre-1.0 release, and as such, does not guarantee backward compatibility. The API, CLI commands, and file formats may change without notice.
11+
12+
## Repository Structure
13+
- `packages/copilot-instructions-cli`: Main CLI application
14+
- `packages/ums-lib`: Core UMS v1.0 library for parsing, validation, and building
15+
- `instructions-modules/`: Directory containing modular instruction files
16+
- `foundation/`: Core cognitive frameworks, reasoning, ethics (layers 0-5)
17+
- `principle/`: Software engineering principles, patterns, methodologies
18+
- `technology/`: Technology-specific guidance (languages, frameworks, tools)
19+
- `execution/`: Playbooks and procedures for specific tasks
20+
- `personas/`: Directory containing persona definition files (`.persona.yml`)
21+
22+
## Core Architecture
23+
The project follows a modular approach where:
24+
1. Individual instruction modules are stored as files in the four-tier hierarchy
25+
2. Modules are validated against schema structures based on their type
26+
3. A build engine combines modules according to persona definitions
27+
4. The compiled output is a markdown document for use with AI assistants
28+
29+
The `BuildEngine` and `ModuleRegistry` classes in `packages/ums-lib/src/core/build-engine.ts` are the central components that orchestrate the build process.
30+
31+
## Development Workflow
32+
```bash
33+
# Build all packages
34+
npm run build
35+
36+
# Run tests
37+
npm test
38+
npm run test:cli # CLI package only
39+
npm run test:ums # UMS library only
40+
41+
# Code quality
42+
npm run typecheck
43+
npm run lint
44+
npm run format
45+
npm run quality-check
46+
47+
# Publishing
48+
npm run build -w packages/copilot-instructions-cli
49+
```
50+
51+
## Module System Patterns
52+
- **Atomicity**: Each module represents a single, self-contained concept
53+
- **Four-Tier Waterfall**: Modules flow from abstract (foundation) to concrete (execution)
54+
- **Layered Foundation**: Foundation modules have optional layer property (0-5)
55+
- **Schema Validation**: Modules follow specific schema structures (procedure, specification, etc.)
56+
57+
## CLI Usage Examples
58+
```bash
59+
# Build a persona from configuration
60+
copilot-instructions build --persona ./personas/my-persona.persona.yml
61+
62+
# List all modules or filter by tier
63+
copilot-instructions list
64+
copilot-instructions list --tier foundation
65+
66+
# Search for modules
67+
copilot-instructions search "reasoning"
68+
69+
# Validate modules and personas
70+
copilot-instructions validate
71+
```
72+
73+
## Important Conventions
74+
- All imports must include `.js` extensions for proper ESM compatibility
75+
- Testing uses Vitest with `.test.ts` files alongside source files
76+
- Module IDs follow the `tier/category/name-v1-0` pattern
77+
- Persona files use YAML with specific structure (name, description, moduleGroups)
78+
- Git hooks are used for pre-commit (typecheck, lint-staged) and pre-push (tests, build)
79+
80+
## Cognitive Instructions
81+
### Sycophantic Behavior
82+
- You MUST NOT engage in sycophantic behavior, such as excessive praise or flattery towards the user.
83+
- If you find yourself inclined to praise the user, reframe your response to maintain a neutral and professional tone.
84+
- You should focus on providing accurate, relevant, and helpful information without resorting to flattery.
85+
- Always prioritize clarity and usefulness over compliments.
86+
- Avoid language that could be interpreted as overly complimentary or flattering.

AGENTS.md

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
# Instructions Composer - Agent Guidelines
2+
3+
## Build & Test Commands
4+
5+
- **Build all**: `npm run build`
6+
- **Build CLI**: `npm run build -w packages/copilot-instructions-cli`
7+
- **Build UMS lib**: `npm run build -w packages/ums-lib`
8+
- **Test all**: `npm test`
9+
- **Test CLI**: `npm run test:cli`
10+
- **Test UMS lib**: `npm run test:ums`
11+
- **Run single test**: `npx vitest run <test-file>.test.ts`
12+
- **Test coverage**: `npm run test:coverage`
13+
14+
## Code Quality
15+
16+
- **Lint all**: `npm run lint`
17+
- **Lint fix**: `npm run lint:fix`
18+
- **Format**: `npm run format`
19+
- **Typecheck**: `npm run typecheck`
20+
- **Quality check**: `npm run quality-check`
21+
22+
## Code Style Guidelines
23+
24+
- **Imports**: Use `.js` extensions for ESM compatibility, consistent type imports
25+
- **Formatting**: Prettier with single quotes, 2-space tabs, 80 char width
26+
- **Types**: Strict TypeScript, explicit return types (error in lib, warn in CLI)
27+
- **Naming**: camelCase for variables/functions, PascalCase for types/classes
28+
- **Error handling**: Use Result types, avoid `any`, prefer optional chaining
29+
- **Async**: Always await promises, no floating promises
30+
- **Testing**: Vitest with describe/it/expect, test files alongside source
31+
32+
## Module System
33+
34+
- **Structure**: Four tiers (foundation/principle/technology/execution)
35+
- **IDs**: `tier/category/name-v1-0` pattern
36+
- **Validation**: Schema-based with YAML modules, TypeScript personas
37+
38+
## Git Workflow
39+
40+
- **Pre-commit**: Typecheck + lint-staged
41+
- **Pre-push**: Typecheck + tests + lint + build
42+
- **Commits**: Follow conventional format with meaningful messages
43+
44+
## Important Conventions
45+
46+
- All packages use ESM with NodeNext modules
47+
- CLI allows console output, library does not
48+
- Maximum complexity: 20 (15 for lib), max depth: 5
49+
- No inline type imports - import types at top of file

0 commit comments

Comments
 (0)