agents-templated 2.2.0 → 2.2.2
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.
- package/README.md +9 -9
- package/bin/cli.js +9 -9
- package/index.js +12 -1
- package/lib/instructions.js +20 -6
- package/lib/layout.js +3 -2
- package/package.json +1 -1
- package/templates/{agents/subagents → .claude/agents}/README.md +2 -2
- package/templates/.claude/rules/ai-integration.mdc +60 -0
- package/templates/.claude/rules/core.mdc +180 -0
- package/templates/.claude/rules/database.mdc +291 -0
- package/templates/.claude/rules/frontend.mdc +224 -0
- package/templates/.claude/rules/guardrails.mdc +105 -0
- package/templates/.claude/rules/hardening.mdc +58 -0
- package/templates/.claude/rules/intent-routing.mdc +59 -0
- package/templates/.claude/rules/planning.mdc +75 -0
- package/templates/.claude/rules/security.mdc +286 -0
- package/templates/.claude/rules/style.mdc +306 -0
- package/templates/.claude/rules/system-workflow.mdc +69 -0
- package/templates/.claude/rules/testing.mdc +308 -0
- package/templates/.claude/rules/workflows.mdc +61 -0
- package/templates/.cursorrules +2 -5
- package/templates/CLAUDE.md +37 -37
- package/templates/README.md +3 -3
- package/templates/agent-docs/ARCHITECTURE.md +3 -3
- package/templates/agent-docs/README.md +12 -13
- package/templates/agents/rules/ai-integration.mdc +10 -2
- package/templates/agents/rules/core.mdc +8 -1
- package/templates/agents/rules/database.mdc +10 -2
- package/templates/agents/rules/frontend.mdc +10 -2
- package/templates/agents/rules/guardrails.mdc +10 -2
- package/templates/agents/rules/hardening.mdc +10 -2
- package/templates/agents/rules/intent-routing.mdc +10 -2
- package/templates/agents/rules/planning.mdc +10 -2
- package/templates/agents/rules/security.mdc +11 -2
- package/templates/agents/rules/style.mdc +10 -2
- package/templates/agents/rules/system-workflow.mdc +10 -2
- package/templates/agents/rules/testing.mdc +9 -1
- package/templates/agents/rules/workflows.mdc +10 -2
- package/templates/agents/skills/README.md +6 -6
- package/templates/instructions/source/core.md +0 -219
- /package/templates/{agents/subagents → .claude/agents}/architect.md +0 -0
- /package/templates/{agents/subagents → .claude/agents}/build-error-resolver.md +0 -0
- /package/templates/{agents/subagents → .claude/agents}/code-reviewer.md +0 -0
- /package/templates/{agents/subagents → .claude/agents}/doc-updater.md +0 -0
- /package/templates/{agents/subagents → .claude/agents}/e2e-runner.md +0 -0
- /package/templates/{agents/subagents → .claude/agents}/planner.md +0 -0
- /package/templates/{agents/subagents → .claude/agents}/refactor-cleaner.md +0 -0
- /package/templates/{agents/subagents → .claude/agents}/security-reviewer.md +0 -0
- /package/templates/{agents/subagents → .claude/agents}/tdd-guide.md +0 -0
|
@@ -0,0 +1,61 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: "Development Workflow Guidelines"
|
|
3
|
+
description: "Apply when optimizing development process, running pre-commit checks, or keeping project healthy"
|
|
4
|
+
alwaysApply: false
|
|
5
|
+
version: "1.0.0"
|
|
6
|
+
tags: ["workflow", "quality", "validation", "commit"]
|
|
7
|
+
globs:
|
|
8
|
+
- "**/*"
|
|
9
|
+
triggers:
|
|
10
|
+
- "User asks about workflow or pre-commit steps"
|
|
11
|
+
- "Need to keep project validated"
|
|
12
|
+
- "Running quality gates before merge"
|
|
13
|
+
- "Post-hardening verification needed"
|
|
14
|
+
---
|
|
15
|
+
|
|
16
|
+
# Development Workflow Guidelines
|
|
17
|
+
|
|
18
|
+
Technology-agnostic suggestions for keeping the project healthy and maintaining quality before commits.
|
|
19
|
+
|
|
20
|
+
## When This Rule Applies
|
|
21
|
+
|
|
22
|
+
Use this guidance when the user asks about workflow, pre-commit checks, or keeping the project validated. Do not force these steps on every change—treat them as recommended practices.
|
|
23
|
+
|
|
24
|
+
## Project Health (agents-templated)
|
|
25
|
+
|
|
26
|
+
If this project was scaffolded with agents-templated:
|
|
27
|
+
|
|
28
|
+
- **Periodically**: Run `agents-templated validate` to ensure required docs and rules are present; run `agents-templated doctor` for environment and configuration recommendations.
|
|
29
|
+
- **After pulling template updates**: Run `agents-templated update --check-only` to see available updates, then `agents-templated update` if you want to apply them (with backup).
|
|
30
|
+
|
|
31
|
+
These commands help keep agent rules, documentation, and security patterns in sync.
|
|
32
|
+
|
|
33
|
+
## Pre-Commit Quality Gates
|
|
34
|
+
|
|
35
|
+
Before committing, consider running (in order):
|
|
36
|
+
|
|
37
|
+
1. **Lint** – Your stack's linter (e.g. ESLint, Pylint, golangci-lint) to catch style and simple issues.
|
|
38
|
+
2. **Type check** – If applicable (TypeScript, mypy, etc.) to catch type errors.
|
|
39
|
+
3. **Tests** – At least the fast test suite (e.g. unit tests) so regressions are caught early.
|
|
40
|
+
4. **Project validation** – For agents-templated projects, `agents-templated validate` can confirm setup is intact.
|
|
41
|
+
|
|
42
|
+
For high-risk or distributed-client releases, add hardening-specific checks before merge/release:
|
|
43
|
+
|
|
44
|
+
5. **Hardening profile selection** – Document threat model and selected profile from `.claude/rules/hardening.mdc`.
|
|
45
|
+
6. **Post-hardening verification** – Run functional regression and performance checks on hardened artifacts.
|
|
46
|
+
7. **Artifact controls** – Verify restricted handling for symbol/mapping/debug artifacts and confirm rollback path.
|
|
47
|
+
|
|
48
|
+
Do not commit with failing lint or tests unless the user explicitly requests a WIP commit (e.g. with `--no-verify` or a clear "work in progress" message).
|
|
49
|
+
|
|
50
|
+
## Commit Messages
|
|
51
|
+
|
|
52
|
+
- Prefer clear, descriptive messages (e.g. conventional commits: `feat:`, `fix:`, `docs:`).
|
|
53
|
+
- Reference issues or tickets when relevant (e.g. "Closes #123").
|
|
54
|
+
- Keep the body focused on what changed and why, not how.
|
|
55
|
+
|
|
56
|
+
## Summary
|
|
57
|
+
|
|
58
|
+
- Use **agents-templated validate** and **doctor** to maintain project setup and get recommendations.
|
|
59
|
+
- Run **lint**, **type check**, and **tests** before committing when possible.
|
|
60
|
+
- For hardening-required releases, include profile rationale, post-hardening verification evidence, and rollback readiness.
|
|
61
|
+
- Write clear commit messages and reference issues where applicable.
|
package/templates/.cursorrules
CHANGED
|
@@ -1,9 +1,6 @@
|
|
|
1
|
-
<!-- GENERATED FILE - DO NOT EDIT DIRECTLY -->
|
|
2
|
-
<!-- Source of truth: instructions/source/core.md -->
|
|
3
1
|
<!-- Tool profile: cursor-compat -->
|
|
4
2
|
# Cursor Rules
|
|
5
3
|
|
|
6
|
-
Primary policy source: `
|
|
4
|
+
Primary policy source: `CLAUDE.md`.
|
|
7
5
|
Load policy only from the canonical source file above.
|
|
8
|
-
|
|
9
|
-
If this file and the canonical source conflict, the canonical source wins.
|
|
6
|
+
If this file and CLAUDE.md conflict, CLAUDE.md wins.
|
package/templates/CLAUDE.md
CHANGED
|
@@ -7,23 +7,23 @@ All policy, routing, and skill governance lives here — edit this file directly
|
|
|
7
7
|
|
|
8
8
|
## Reference Index
|
|
9
9
|
|
|
10
|
-
### Rule modules (`.
|
|
11
|
-
|
|
12
|
-
| Module | File |
|
|
13
|
-
|
|
14
|
-
| Security | `.
|
|
15
|
-
| Testing | `.
|
|
16
|
-
| Core | `.
|
|
17
|
-
| Database | `.
|
|
18
|
-
| Frontend | `.
|
|
19
|
-
| Style | `.
|
|
20
|
-
| System Workflow | `.
|
|
21
|
-
| Workflows | `.
|
|
22
|
-
| Hardening | `.
|
|
23
|
-
| Intent Routing | `.
|
|
24
|
-
| Planning | `.
|
|
25
|
-
| AI Integration | `.
|
|
26
|
-
| Guardrails | `.
|
|
10
|
+
### Rule modules (`.claude/rules/`)
|
|
11
|
+
|
|
12
|
+
| Module | File | Apply when... |
|
|
13
|
+
|--------|------|---------------|
|
|
14
|
+
| Security | `.claude/rules/security.mdc` | Implementing authentication, validating inputs, protecting against injection attacks |
|
|
15
|
+
| Testing | `.claude/rules/testing.mdc` | Adding tests, verifying coverage, validating quality before deployment |
|
|
16
|
+
| Core | `.claude/rules/core.mdc` | Designing architecture, setting up projects, defining type systems |
|
|
17
|
+
| Database | `.claude/rules/database.mdc` | Designing schema, building data access layers, optimizing queries |
|
|
18
|
+
| Frontend | `.claude/rules/frontend.mdc` | Building UI components, designing pages, creating forms, implementing accessibility |
|
|
19
|
+
| Style | `.claude/rules/style.mdc` | Organizing code, naming variables, improving clarity and maintainability |
|
|
20
|
+
| System Workflow | `.claude/rules/system-workflow.mdc` | Planning delivery phases, defining acceptance criteria, establishing rollback |
|
|
21
|
+
| Workflows | `.claude/rules/workflows.mdc` | Optimizing development process, running pre-commit checks, keeping project healthy |
|
|
22
|
+
| Hardening | `.claude/rules/hardening.mdc` | Building distributed apps, protecting IP logic, preparing production releases |
|
|
23
|
+
| Intent Routing | `.claude/rules/intent-routing.mdc` | Determining which rule applies, routing to correct execution pathway |
|
|
24
|
+
| Planning | `.claude/rules/planning.mdc` | Implementing features, designing systems, making architectural decisions |
|
|
25
|
+
| AI Integration | `.claude/rules/ai-integration.mdc` | Integrating LLMs, RAG pipelines, prompt engineering, AI-powered features |
|
|
26
|
+
| Guardrails | `.claude/rules/guardrails.mdc` | Any destructive/irreversible action, scope expansion, dangerous requests |
|
|
27
27
|
|
|
28
28
|
### Skill modules (`.github/skills/`)
|
|
29
29
|
|
|
@@ -39,19 +39,19 @@ All policy, routing, and skill governance lives here — edit this file directly
|
|
|
39
39
|
|
|
40
40
|
Skills add capability only. They must not override security, testing, or core constraints.
|
|
41
41
|
|
|
42
|
-
### Subagent modules (
|
|
42
|
+
### Subagent modules (`.claude/agents/`)
|
|
43
43
|
|
|
44
44
|
| Subagent | Path | Invoke when... |
|
|
45
45
|
|----------|------|----------------|
|
|
46
|
-
| planner |
|
|
47
|
-
| architect |
|
|
48
|
-
| tdd-guide |
|
|
49
|
-
| code-reviewer |
|
|
50
|
-
| security-reviewer |
|
|
51
|
-
| build-error-resolver |
|
|
52
|
-
| e2e-runner |
|
|
53
|
-
| refactor-cleaner |
|
|
54
|
-
| doc-updater |
|
|
46
|
+
| planner | `.claude/agents/planner.md` | Breaking down features into phased plans |
|
|
47
|
+
| architect | `.claude/agents/architect.md` | System design decisions, ADRs, trade-off analysis |
|
|
48
|
+
| tdd-guide | `.claude/agents/tdd-guide.md` | Writing tests before implementation |
|
|
49
|
+
| code-reviewer | `.claude/agents/code-reviewer.md` | Reviewing code for quality and correctness |
|
|
50
|
+
| security-reviewer | `.claude/agents/security-reviewer.md` | Scanning for security vulnerabilities |
|
|
51
|
+
| build-error-resolver | `.claude/agents/build-error-resolver.md` | Fixing build and type errors |
|
|
52
|
+
| e2e-runner | `.claude/agents/e2e-runner.md` | Running Playwright E2E test suites |
|
|
53
|
+
| refactor-cleaner | `.claude/agents/refactor-cleaner.md` | Removing dead code and unused dependencies |
|
|
54
|
+
| doc-updater | `.claude/agents/doc-updater.md` | Syncing docs and READMEs after code changes |
|
|
55
55
|
|
|
56
56
|
Subagents are bounded agents with limited tool access. They inherit all policy from this file and may not override security, testing, or core constraints.
|
|
57
57
|
|
|
@@ -59,40 +59,40 @@ Subagents are bounded agents with limited tool access. They inherit all policy f
|
|
|
59
59
|
|
|
60
60
|
## Always Enforce
|
|
61
61
|
|
|
62
|
-
1. **Security-first (non-overrideable)** — `.
|
|
62
|
+
1. **Security-first (non-overrideable)** — `.claude/rules/security.mdc`
|
|
63
63
|
- Validate all external inputs at boundaries.
|
|
64
64
|
- Require authentication and role-based authorization for protected operations.
|
|
65
65
|
- Rate-limit public APIs.
|
|
66
66
|
- Never expose secrets, credentials, or PII in logs/errors/responses.
|
|
67
67
|
|
|
68
|
-
2. **Testing discipline (non-overrideable)** — `.
|
|
68
|
+
2. **Testing discipline (non-overrideable)** — `.claude/rules/testing.mdc`
|
|
69
69
|
- Coverage mix target: Unit 80% / Integration 15% / E2E 5%.
|
|
70
70
|
- Business logic must have tests; critical flows need integration coverage.
|
|
71
71
|
- Never disable/remove tests to pass builds.
|
|
72
72
|
|
|
73
|
-
3. **Type safety and runtime boundaries** — `.
|
|
73
|
+
3. **Type safety and runtime boundaries** — `.claude/rules/core.mdc`
|
|
74
74
|
- Strong internal typing, runtime validation at boundaries, explicit error models.
|
|
75
75
|
|
|
76
|
-
4. **Database integrity** — `.
|
|
76
|
+
4. **Database integrity** — `.claude/rules/database.mdc`
|
|
77
77
|
- Prefer ORM/ODM, justify raw queries, enforce DB constraints, prevent N+1, reversible migrations.
|
|
78
78
|
|
|
79
|
-
5. **Frontend standards** — `.
|
|
79
|
+
5. **Frontend standards** — `.claude/rules/frontend.mdc`
|
|
80
80
|
- WCAG 2.1 AA, responsive defaults, clear loading/error states, no unsafe client trust.
|
|
81
81
|
|
|
82
|
-
6. **Style and consistency** — `.
|
|
82
|
+
6. **Style and consistency** — `.claude/rules/style.mdc`
|
|
83
83
|
- Consistent naming, small composable modules, explicit contracts, no magic values.
|
|
84
84
|
|
|
85
|
-
7. **Workflow discipline** — `.
|
|
85
|
+
7. **Workflow discipline** — `.claude/rules/system-workflow.mdc`, `.claude/rules/workflows.mdc`
|
|
86
86
|
- Feature branches only, no direct main edits, deterministic PR structure, review gates.
|
|
87
87
|
|
|
88
|
-
8. **Hardening mode** — `.
|
|
88
|
+
8. **Hardening mode** — `.claude/rules/hardening.mdc`
|
|
89
89
|
- In hardening/audit contexts: assume hostile input, threat-model, validate config safety, strict rate limits, dependency audit.
|
|
90
90
|
|
|
91
|
-
9. **Planning discipline** — `.
|
|
91
|
+
9. **Planning discipline** — `.claude/rules/planning.mdc`
|
|
92
92
|
- Every feature discussion or implementation produces a `.github/prompts/` plan file.
|
|
93
93
|
- Plans are updated as work progresses, not discarded.
|
|
94
94
|
|
|
95
|
-
10. **Guardrails (non-overrideable)** — `.
|
|
95
|
+
10. **Guardrails (non-overrideable)** — `.claude/rules/guardrails.mdc`
|
|
96
96
|
- Require `CONFIRM-DESTRUCTIVE:<target>` token before any destructive/irreversible action.
|
|
97
97
|
- Work only within the defined task scope; no silent expansion.
|
|
98
98
|
- Classify every action by reversibility before executing.
|
package/templates/README.md
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
[](https://www.npmjs.com/package/agents-templated)
|
|
4
4
|
[](https://www.npmjs.com/package/agents-templated)
|
|
5
5
|
[](https://opensource.org/licenses/MIT)
|
|
6
|
-
[](https://github.com/rickandrew2/agents-templated)
|
|
7
7
|
|
|
8
8
|
> **Agents Templated** is a CLI tool and npm package that instantly scaffolds production-ready project structures with enterprise-grade development patterns, security guidelines, and AI assistant configurations. Designed for developers who want to start projects the right way—with proven OWASP security practices, comprehensive testing strategies (80/15/5 coverage targets), and agent-based architecture patterns—without being locked into specific frameworks. It generates unified configuration files that work seamlessly with Cursor, GitHub Copilot, Claude, and Google Gemini, allowing AI assistants to automatically follow best practices from day one. Whether you're building a Next.js app, Django API, Go microservice, or any custom stack, Agents Templated provides the guardrails and patterns you need while giving you complete freedom to choose your technology.
|
|
9
9
|
|
|
@@ -105,7 +105,7 @@ Agents Templated automatically configures compatible wrappers for major AI codin
|
|
|
105
105
|
| **Claude** | `CLAUDE.md` | ✅ Compatible |
|
|
106
106
|
| **Generic agents** | `AGENTS.MD` | ✅ Compatible |
|
|
107
107
|
|
|
108
|
-
**Single source of truth:** `
|
|
108
|
+
**Single source of truth:** `CLAUDE.md` drives generated tool-compatible instruction files.
|
|
109
109
|
|
|
110
110
|
---
|
|
111
111
|
|
|
@@ -395,7 +395,7 @@ await agentsTemplated.install('./my-project', {
|
|
|
395
395
|
|
|
396
396
|
When contributing to this template:
|
|
397
397
|
1. Maintain technology-agnostic patterns
|
|
398
|
-
2. Update relevant rule files in
|
|
398
|
+
2. Update relevant rule files in `.github/instructions/rules/`
|
|
399
399
|
3. Keep documentation synchronized with code changes
|
|
400
400
|
4. Follow security and testing patterns
|
|
401
401
|
5. Ensure AI assistant configurations remain compatible
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
This is a **technology-agnostic development template** with enterprise-grade patterns for security, testing, and developer experience.
|
|
4
4
|
These guidelines are for both humans and AI assistants working with any technology stack.
|
|
5
5
|
|
|
6
|
-
- Canonical AI policy source lives in `
|
|
6
|
+
- Canonical AI policy source lives in `CLAUDE.md`.
|
|
7
7
|
- **Agent responsibilities** and MCP integration are documented in `AGENTS.MD`.
|
|
8
8
|
- **Detailed implementation rules** live in `.github/instructions/rules/*.mdc` files.
|
|
9
9
|
- **Custom skills** for domain-specific tasks are organized in `.github/skills/` (see [Skills Guide](../.github/skills/README.md)).
|
|
@@ -224,8 +224,8 @@ Review the options above and select technologies that fit your:
|
|
|
224
224
|
|
|
225
225
|
### 2. Adapt the Template
|
|
226
226
|
- Update `.github/instructions/rules/*.mdc` files with technology-specific patterns
|
|
227
|
-
- Keep `.cursorrules`, `.github/copilot-instructions.md`, `AGENTS.MD`, and `CLAUDE.md` as minimal wrappers that point to `
|
|
228
|
-
- Update `
|
|
227
|
+
- Keep `.cursorrules`, `.github/copilot-instructions.md`, `AGENTS.MD`, and `CLAUDE.md` as minimal wrappers that point to `CLAUDE.md`
|
|
228
|
+
- Update `CLAUDE.md` with stack-specific guidelines
|
|
229
229
|
- Create appropriate configuration files for your chosen tools
|
|
230
230
|
|
|
231
231
|
### 3. Implement Core Patterns
|
|
@@ -6,12 +6,11 @@ This template has been installed by the agents-templated npm package.
|
|
|
6
6
|
|
|
7
7
|
Depending on what you installed, you may have:
|
|
8
8
|
|
|
9
|
-
- **AGENTS.MD**:
|
|
9
|
+
- **AGENTS.MD**: Generic compatibility wrapper for AI assistants
|
|
10
10
|
- **ARCHITECTURE.md**: Project guidelines and architecture
|
|
11
|
-
- **
|
|
12
|
-
-
|
|
13
|
-
-
|
|
14
|
-
- **instructions/source/core.md**: Canonical policy source (single source of truth)
|
|
11
|
+
- **CLAUDE.md**: Canonical policy source (single source of truth)
|
|
12
|
+
- **.github/instructions/rules/**: Rule modules (`*.mdc`)
|
|
13
|
+
- **.github/skills/**: Skill modules (`*/SKILL.md`)
|
|
15
14
|
- **CLAUDE.md**: Claude compatibility wrapper
|
|
16
15
|
- **.github/copilot-instructions.md**: GitHub Copilot compatibility wrapper
|
|
17
16
|
- **.cursorrules**: Cursor compatibility wrapper
|
|
@@ -36,8 +35,8 @@ agents-templated list
|
|
|
36
35
|
|
|
37
36
|
## Rules and Skills
|
|
38
37
|
|
|
39
|
-
- **Rules** (
|
|
40
|
-
- **Skills** (
|
|
38
|
+
- **Rules** (`.github/instructions/rules/*.mdc`): Define *how to behave* - patterns, principles, and standards for your team
|
|
39
|
+
- **Skills** (`.github/skills/*/SKILL.md`): Define *how to execute specific tasks* - domain-specific workflows and specialized knowledge
|
|
41
40
|
|
|
42
41
|
### Using Skills in Your AI Assistants
|
|
43
42
|
|
|
@@ -45,31 +44,31 @@ Skills can be referenced in all AI configuration files:
|
|
|
45
44
|
|
|
46
45
|
**In `.cursorrules` (Cursor IDE):**
|
|
47
46
|
```
|
|
48
|
-
When the user asks about [domain], use the [skill-name] skill from
|
|
47
|
+
When the user asks about [domain], use the [skill-name] skill from .github/skills/[skill-name]/SKILL.md
|
|
49
48
|
```
|
|
50
49
|
|
|
51
50
|
**In `CLAUDE.md` (Claude):**
|
|
52
51
|
```
|
|
53
52
|
|
|
54
|
-
When working on [domain-specific task], reference the [skill-name] skill in
|
|
53
|
+
When working on [domain-specific task], reference the [skill-name] skill in .github/skills/[skill-name]/SKILL.md
|
|
55
54
|
```
|
|
56
55
|
|
|
57
56
|
**In `.github/copilot-instructions.md` (GitHub Copilot):**
|
|
58
57
|
```
|
|
59
|
-
When helping with [domain-specific task], reference the [skill-name] skill from
|
|
58
|
+
When helping with [domain-specific task], reference the [skill-name] skill from .github/skills/[skill-name]/SKILL.md
|
|
60
59
|
```
|
|
61
60
|
|
|
62
|
-
All wrappers point to `
|
|
61
|
+
All wrappers point to `CLAUDE.md`, and skills can be referenced from any assistant through that canonical policy. Create custom skills in `.github/skills/` to extend capabilities across your entire team.
|
|
63
62
|
|
|
64
63
|
## Getting Started
|
|
65
64
|
|
|
66
65
|
1. Review AGENTS.MD for AI assistance guidance
|
|
67
66
|
2. Review ARCHITECTURE.md for overall project guidelines
|
|
68
67
|
3. Adapt the rules to your specific technology stack
|
|
69
|
-
4. Create custom skills in
|
|
68
|
+
4. Create custom skills in `.github/skills/` for your domain
|
|
70
69
|
5. Configure your AI assistants (Cursor, Copilot, Claude, generic agents) to reference your skills
|
|
71
70
|
|
|
72
71
|
## Documentation
|
|
73
72
|
|
|
74
|
-
For full documentation, visit: https://github.com/rickandrew2/agents-
|
|
73
|
+
For full documentation, visit: https://github.com/rickandrew2/agents-templated
|
|
75
74
|
|
|
@@ -1,10 +1,18 @@
|
|
|
1
1
|
---
|
|
2
2
|
title: "AI / LLM Integration"
|
|
3
|
-
description: "
|
|
4
|
-
version: "
|
|
3
|
+
description: "Apply when integrating LLMs, RAG pipelines, prompt engineering, or building AI-powered features. Covers safety, cost, and quality"
|
|
4
|
+
version: "3.0.0"
|
|
5
5
|
tags: ["ai", "llm", "openai", "anthropic", "rag", "prompt-engineering", "safety"]
|
|
6
6
|
alwaysApply: false
|
|
7
7
|
globs: ["**/*llm*", "**/*openai*", "**/*anthropic*", "**/*langchain*", "**/*rag*", "**/ai/**"]
|
|
8
|
+
triggers:
|
|
9
|
+
- "Integrating OpenAI or other LLM API"
|
|
10
|
+
- "Building RAG pipeline or semantic search"
|
|
11
|
+
- "Implementing prompt template or engineering"
|
|
12
|
+
- "Adding AI-powered feature to application"
|
|
13
|
+
- "Evaluating LLM responses or quality"
|
|
14
|
+
- "Optimizing LLM API costs"
|
|
15
|
+
- "Implementing AI moderation or safety controls"
|
|
8
16
|
---
|
|
9
17
|
|
|
10
18
|
## Purpose
|
|
@@ -1,11 +1,18 @@
|
|
|
1
1
|
---
|
|
2
2
|
title: "Core Project Guidelines"
|
|
3
|
-
description: "
|
|
3
|
+
description: "Apply to all architecture, type safety, code organization, and enterprise quality standards. Foundation for every feature"
|
|
4
4
|
alwaysApply: true
|
|
5
5
|
version: "3.0.0"
|
|
6
6
|
tags: ["architecture", "core", "enterprise", "technology-agnostic"]
|
|
7
7
|
globs:
|
|
8
8
|
- "*"
|
|
9
|
+
triggers:
|
|
10
|
+
- "Designing application architecture"
|
|
11
|
+
- "Setting up new project or module"
|
|
12
|
+
- "Defining type systems and validation"
|
|
13
|
+
- "Organizing code structure"
|
|
14
|
+
- "Improving code quality standards"
|
|
15
|
+
- "Making testing or performance decisions"
|
|
9
16
|
---
|
|
10
17
|
|
|
11
18
|
## Developer Identity
|
|
@@ -1,12 +1,20 @@
|
|
|
1
1
|
---
|
|
2
2
|
title: "Database and Data Layer Guidelines"
|
|
3
|
-
description: "
|
|
3
|
+
description: "Apply when designing schema, building data access layers, optimizing queries, or managing database operations"
|
|
4
4
|
alwaysApply: true
|
|
5
5
|
version: "3.0.0"
|
|
6
6
|
tags: ["database", "backend", "data", "orm", "schema"]
|
|
7
7
|
globs:
|
|
8
8
|
- "src/models/**/*"
|
|
9
9
|
- "src/data/**/*"
|
|
10
|
+
triggers:
|
|
11
|
+
- "Designing database schema"
|
|
12
|
+
- "Adding database migrations"
|
|
13
|
+
- "Building data access layer"
|
|
14
|
+
- "Querying or filtering data"
|
|
15
|
+
- "Optimizing slow queries"
|
|
16
|
+
- "Managing relationships between entities"
|
|
17
|
+
- "Handling data validation in models"
|
|
10
18
|
---
|
|
11
19
|
|
|
12
20
|
# Database and Data Layer Guidelines
|
|
@@ -302,4 +310,4 @@ Test: Cascade delete
|
|
|
302
310
|
|
|
303
311
|
---
|
|
304
312
|
|
|
305
|
-
Remember: Good database design prevents bugs, improves performance, and makes your application maintainable.
|
|
313
|
+
Remember: Good database design prevents bugs, improves performance, and makes your application maintainable.
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
---
|
|
2
2
|
title: "Frontend Development Guidelines"
|
|
3
|
-
description: "
|
|
3
|
+
description: "Apply when building UI components, designing pages, creating forms, or implementing accessibility and responsive interfaces"
|
|
4
4
|
alwaysApply: true
|
|
5
5
|
version: "3.0.0"
|
|
6
6
|
tags: ["frontend", "ui", "ux", "security", "accessibility"]
|
|
@@ -8,6 +8,14 @@ globs:
|
|
|
8
8
|
- "src/**/*"
|
|
9
9
|
- "components/**/*"
|
|
10
10
|
- "public/**/*"
|
|
11
|
+
triggers:
|
|
12
|
+
- "Building UI components or pages"
|
|
13
|
+
- "Creating forms and handling user input"
|
|
14
|
+
- "Designing responsive layouts"
|
|
15
|
+
- "Implementing accessibility features"
|
|
16
|
+
- "Styling and theming interfaces"
|
|
17
|
+
- "Building navigation and routing"
|
|
18
|
+
- "Implementing client-side state management"
|
|
11
19
|
---
|
|
12
20
|
|
|
13
21
|
# Frontend Development Guidelines
|
|
@@ -214,4 +222,4 @@ E2E tests:
|
|
|
214
222
|
|
|
215
223
|
---
|
|
216
224
|
|
|
217
|
-
Remember: Build user interfaces that work for everyone, load quickly, and provide excellent user experience.
|
|
225
|
+
Remember: Build user interfaces that work for everyone, load quickly, and provide excellent user experience.
|
|
@@ -1,9 +1,17 @@
|
|
|
1
1
|
---
|
|
2
2
|
alwaysApply: true
|
|
3
3
|
title: "AI Agent Guardrails"
|
|
4
|
-
description: "
|
|
5
|
-
version: "
|
|
4
|
+
description: "Apply before any irreversible action, scope expansion, dangerous request, or system change. Safety constraints that cannot be weakened"
|
|
5
|
+
version: "3.0.0"
|
|
6
6
|
tags: ["guardrails", "safety", "scope", "reversibility", "agent-behavior"]
|
|
7
|
+
triggers:
|
|
8
|
+
- "Planning destructive or irreversible action"
|
|
9
|
+
- "Deleting files, databases, or deployment"
|
|
10
|
+
- "Modifying security or authentication"
|
|
11
|
+
- "Making scope expansion decisions"
|
|
12
|
+
- "Evaluating request safety and reversibility"
|
|
13
|
+
- "Handling secrets or sensitive data"
|
|
14
|
+
- "Making agent behavioral decisions"
|
|
7
15
|
---
|
|
8
16
|
|
|
9
17
|
## Purpose
|
|
@@ -1,8 +1,16 @@
|
|
|
1
1
|
---
|
|
2
2
|
title: "Application Hardening & Obfuscation"
|
|
3
|
-
description: "
|
|
4
|
-
version: "
|
|
3
|
+
description: "Apply when building distributed apps, protecting IP logic, preparing production releases, or hardening against reverse engineering"
|
|
4
|
+
version: "3.0.0"
|
|
5
5
|
tags: ["hardening", "obfuscation", "anti-tamper", "security"]
|
|
6
|
+
triggers:
|
|
7
|
+
- "Preparing mobile or desktop app for release"
|
|
8
|
+
- "Protecting proprietary business logic"
|
|
9
|
+
- "Hardening against reverse engineering"
|
|
10
|
+
- "Building distributed client applications"
|
|
11
|
+
- "Preparing production release with hardening"
|
|
12
|
+
- "Implementing tamper detection"
|
|
13
|
+
- "Adding integrity checks to release"
|
|
6
14
|
---
|
|
7
15
|
|
|
8
16
|
## Purpose
|
|
@@ -1,8 +1,16 @@
|
|
|
1
1
|
---
|
|
2
2
|
title: "Intent Routing & Command Selection"
|
|
3
|
-
description: "
|
|
4
|
-
version: "
|
|
3
|
+
description: "Apply when determining which rule applies, routing to correct execution pathway, or making command selection decisions"
|
|
4
|
+
version: "3.0.0"
|
|
5
5
|
tags: ["routing", "deterministic", "workflow", "commands"]
|
|
6
|
+
triggers:
|
|
7
|
+
- "User makes natural language request"
|
|
8
|
+
- "Determining which rule applies"
|
|
9
|
+
- "Routing to correct execution pathway"
|
|
10
|
+
- "Selecting command or agent to invoke"
|
|
11
|
+
- "Handling ambiguous user intent"
|
|
12
|
+
- "Making safety behavior decisions"
|
|
13
|
+
- "Validating action scope and appropriateness"
|
|
6
14
|
---
|
|
7
15
|
|
|
8
16
|
## Purpose
|
|
@@ -1,9 +1,17 @@
|
|
|
1
1
|
---
|
|
2
2
|
title: "Planning Discipline"
|
|
3
|
-
description: "
|
|
4
|
-
version: "
|
|
3
|
+
description: "Apply when implementing features, designing systems, discussing architecture, or making implementation decisions. Produces reusable prompt plan files"
|
|
4
|
+
version: "3.0.0"
|
|
5
5
|
tags: ["planning", "workflow", "documentation", "prompts"]
|
|
6
6
|
alwaysApply: true
|
|
7
|
+
triggers:
|
|
8
|
+
- "User requests a new feature"
|
|
9
|
+
- "Planning implementation approach"
|
|
10
|
+
- "Discussing architectural changes"
|
|
11
|
+
- "Breaking down user stories"
|
|
12
|
+
- "Creating acceptance criteria"
|
|
13
|
+
- "Designing database schema"
|
|
14
|
+
- "Planning deployment phases"
|
|
7
15
|
---
|
|
8
16
|
|
|
9
17
|
## Purpose
|
|
@@ -1,8 +1,17 @@
|
|
|
1
1
|
---
|
|
2
2
|
title: "Security Rules & Best Practices"
|
|
3
|
-
description: "
|
|
3
|
+
description: "Apply when implementing authentication, authorization, API validation, secrets management, or protecting against OWASP Top 10 vulnerabilities"
|
|
4
|
+
alwaysApply: true
|
|
4
5
|
version: "3.0.0"
|
|
5
|
-
tags: ["security", "
|
|
6
|
+
tags: ["security", "auth", "validation", "secrets", "owasp"]
|
|
7
|
+
triggers:
|
|
8
|
+
- "User adds login/authentication to project"
|
|
9
|
+
- "Building API endpoints or handling user input"
|
|
10
|
+
- "Storing passwords, tokens, or sensitive data"
|
|
11
|
+
- "Validating form inputs or API requests"
|
|
12
|
+
- "Protecting against injection, XSS, CSRF"
|
|
13
|
+
- "Adding authorization/permissions to endpoints"
|
|
14
|
+
- "Integrating third-party APIs or external services"
|
|
6
15
|
---
|
|
7
16
|
|
|
8
17
|
# Security Rules & Best Practices
|
|
@@ -1,11 +1,19 @@
|
|
|
1
1
|
---
|
|
2
2
|
title: "Code Style and Standards"
|
|
3
|
-
description: "
|
|
3
|
+
description: "Apply when organizing code, naming variables/functions, improving clarity, formatting with consistency, and maintaining code quality"
|
|
4
4
|
alwaysApply: true
|
|
5
5
|
version: "3.0.0"
|
|
6
6
|
tags: ["style", "formatting", "naming", "quality"]
|
|
7
7
|
globs:
|
|
8
8
|
- "**/*"
|
|
9
|
+
triggers:
|
|
10
|
+
- "Writing new code or functions"
|
|
11
|
+
- "Organizing code structure"
|
|
12
|
+
- "Naming variables, functions, or classes"
|
|
13
|
+
- "Formatting code for readability"
|
|
14
|
+
- "Improving code documentation"
|
|
15
|
+
- "Refactoring for clarity"
|
|
16
|
+
- "Following project conventions"
|
|
9
17
|
---
|
|
10
18
|
|
|
11
19
|
# Code Style and Standards
|
|
@@ -341,4 +349,4 @@ Test names describe what is being tested:
|
|
|
341
349
|
---
|
|
342
350
|
|
|
343
351
|
Remember: **Write code for humans first, computers second.**
|
|
344
|
-
Clean code is maintainable code, and maintainable code is more secure, performant, and bug-free.
|
|
352
|
+
Clean code is maintainable code, and maintainable code is more secure, performant, and bug-free.
|
|
@@ -1,8 +1,16 @@
|
|
|
1
1
|
---
|
|
2
2
|
title: "System Workflow Orchestration"
|
|
3
|
-
description: "
|
|
4
|
-
version: "
|
|
3
|
+
description: "Apply when planning delivery phases, defining acceptance criteria, establishing rollback procedures, or orchestrating multi-step workflows"
|
|
4
|
+
version: "3.0.0"
|
|
5
5
|
tags: ["workflow", "gates", "delivery", "governance"]
|
|
6
|
+
triggers:
|
|
7
|
+
- "Implementing feature with multiple phases"
|
|
8
|
+
- "Defining deployment gates and approval"
|
|
9
|
+
- "Planning rollback strategy"
|
|
10
|
+
- "Creating acceptance criteria"
|
|
11
|
+
- "Coordinating deployment across services"
|
|
12
|
+
- "Planning database migration"
|
|
13
|
+
- "Managing breaking API changes"
|
|
6
14
|
---
|
|
7
15
|
|
|
8
16
|
## Purpose
|
|
@@ -1,8 +1,16 @@
|
|
|
1
1
|
---
|
|
2
2
|
title: "Testing Guidelines & Best Practices"
|
|
3
|
-
description: "
|
|
3
|
+
description: "Apply when adding tests, verifying coverage, or validating quality before deployment. Always required for business logic and critical flows"
|
|
4
4
|
version: "3.0.0"
|
|
5
5
|
tags: ["testing", "quality", "coverage", "e2e", "a11y"]
|
|
6
|
+
triggers:
|
|
7
|
+
- "User requests tests for business logic"
|
|
8
|
+
- "Implementing a new feature"
|
|
9
|
+
- "Fixing a bug"
|
|
10
|
+
- "Need to verify API endpoints work"
|
|
11
|
+
- "Checking application behavior"
|
|
12
|
+
- "Hardening release artifacts"
|
|
13
|
+
- "CI/CD validation needed before deployment"
|
|
6
14
|
---
|
|
7
15
|
|
|
8
16
|
# Testing Guidelines & Best Practices
|
|
@@ -1,11 +1,19 @@
|
|
|
1
1
|
---
|
|
2
2
|
title: "Development Workflow Guidelines"
|
|
3
|
-
description: "
|
|
3
|
+
description: "Apply to optimize development process, running pre-commit checks, enforcing quality gates, and keeping project healthy"
|
|
4
4
|
alwaysApply: false
|
|
5
|
-
version: "
|
|
5
|
+
version: "3.0.0"
|
|
6
6
|
tags: ["workflow", "quality", "validation", "commit"]
|
|
7
7
|
globs:
|
|
8
8
|
- "**/*"
|
|
9
|
+
triggers:
|
|
10
|
+
- "Running pre-commit hooks"
|
|
11
|
+
- "Validating code quality gates"
|
|
12
|
+
- "Setting up CI/CD pipeline"
|
|
13
|
+
- "Checking code before commit"
|
|
14
|
+
- "Running linting or formatting"
|
|
15
|
+
- "Executing test suites automatically"
|
|
16
|
+
- "Maintaining project health and standards"
|
|
9
17
|
---
|
|
10
18
|
|
|
11
19
|
# Development Workflow Guidelines
|