Skip to content

Commit 341a07d

Browse files
authored
Merge pull request #9 from Open-Paws/chore/agent-context-cleanup
chore: add CLAUDE.md agent context
2 parents 96766e4 + cb7a7f1 commit 341a07d

2 files changed

Lines changed: 79 additions & 0 deletions

File tree

CLAUDE.md

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
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

LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2024-2026 Open Paws
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

0 commit comments

Comments
 (0)