|
| 1 | +# Structured Coding with AI |
| 2 | + |
| 3 | +Ready-to-use AI coding instruction files for 12 tools, tailored for animal advocacy software. Copy a tool directory into any project root and the AI assistant immediately understands advocacy-domain constraints, security threat models, testing standards, and process workflows. Part of the Open Paws developer pipeline. |
| 4 | + |
| 5 | +## Quick Start |
| 6 | + |
| 7 | +No build step. Pick a tool directory, copy its files into your project: |
| 8 | + |
| 9 | +```bash |
| 10 | +# Example: Claude Code |
| 11 | +cp claude-code/CLAUDE.md your-project/ |
| 12 | +cp claude-code/hooks-template.md your-project/ |
| 13 | +cp -r claude-code/.claude your-project/ |
| 14 | +``` |
| 15 | + |
| 16 | +See README.md for copy commands for all 12 tools. |
| 17 | + |
| 18 | +## Architecture |
| 19 | + |
| 20 | +``` |
| 21 | +claude-code/ 15 files — CLAUDE.md + scoped rules + skills + hooks template |
| 22 | +cursor/ 14 files — .cursorrules + .mdc files (4 activation modes) |
| 23 | +github-copilot/ 22 files — copilot-instructions + prompts + chat modes + skills |
| 24 | +windsurf/ 14 files — .windsurf/rules/ (4 trigger types, 6K/12K char limits) |
| 25 | +kilo-code/ 21 files — mode files + Memory Bank + concerns + skills |
| 26 | +cline/ 14 files — .clinerules/ (Plan/Act paradigm) |
| 27 | +roo-code/ 19 files — .roomodes JSON + mode rules + concerns + skills |
| 28 | +augment-code/ 14 files — .augment/rules/ |
| 29 | +aider/ 1 file — CONVENTIONS.md (all-in-one) |
| 30 | +gemini-cli/ 1 file — GEMINI.md (all-in-one) |
| 31 | +jetbrains-junie/ 1 file — .junie/guidelines.md (all-in-one) |
| 32 | +agents-md/ 1 file — AGENTS.md (vendor-neutral, 20+ tools) |
| 33 | +``` |
| 34 | + |
| 35 | +137 files total across 12 tool directories. |
| 36 | + |
| 37 | +## Key Files |
| 38 | + |
| 39 | +| File | Purpose | |
| 40 | +|------|---------| |
| 41 | +| `README.md` | Full tool comparison, copy commands, content coverage | |
| 42 | +| `claude-code/CLAUDE.md` | Claude Code root instruction file | |
| 43 | +| `claude-code/hooks-template.md` | Pre-commit/post-edit/pre-push hook setup guide | |
| 44 | +| `agents-md/AGENTS.md` | Universal fallback for any unsupported tool | |
| 45 | + |
| 46 | +## Content Coverage |
| 47 | + |
| 48 | +All 12 tools cover the same 7 concerns and 6 process skills: |
| 49 | + |
| 50 | +**Concerns:** Testing, Security, Privacy, Cost optimization, Advocacy domain, Accessibility, Emotional safety |
| 51 | + |
| 52 | +**Skills:** git-workflow, testing-strategy, requirements-interview, plan-first-development, code-review, security-audit |
| 53 | + |
| 54 | +## Development |
| 55 | + |
| 56 | +- **No dependencies** -- pure markdown/JSON instruction files |
| 57 | +- **Adding a new tool:** Create `tool-name/` directory, implement the 7 concerns + 6 skills in the tool's native format |
| 58 | +- **Editing content:** Each tool was independently authored for its format -- changes to one do not auto-propagate to others |
0 commit comments