kartman-dev 1.0.0-dev.0
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/dist/claude-config/_claude-plugin/plugin.json +11 -0
- package/dist/claude-config/_mcp.json +38 -0
- package/dist/claude-config/commands/linear-issue.md +59 -0
- package/dist/claude-config/commands/linear-project.md +70 -0
- package/dist/claude-config/hooks/hooks.json +14 -0
- package/dist/claude-config/scripts/block-secrets.sh +71 -0
- package/dist/claude-config/skills/doc-drift-check/SKILL.md +140 -0
- package/dist/claude-config/skills/doc-drift-check/references/severity-guide.md +174 -0
- package/dist/claude-config/worktrees/polymorphic-cooking-goose/.claude/.claude-plugin/plugin.json +11 -0
- package/dist/claude-config/worktrees/polymorphic-cooking-goose/.claude/.mcp.json +23 -0
- package/dist/claude-config/worktrees/polymorphic-cooking-goose/.claude/settings.json +13 -0
- package/dist/claude-config/worktrees/polymorphic-cooking-goose/.claude/skills/doc-drift-check/SKILL.md +140 -0
- package/dist/claude-config/worktrees/polymorphic-cooking-goose/.claude/skills/doc-drift-check/references/severity-guide.md +174 -0
- package/dist/claude-config/worktrees/valiant-sparking-hare/.claude/.claude-plugin/plugin.json +11 -0
- package/dist/claude-config/worktrees/valiant-sparking-hare/.claude/.mcp.json +23 -0
- package/dist/claude-config/worktrees/valiant-sparking-hare/.claude/commands/linear-issue.md +59 -0
- package/dist/claude-config/worktrees/valiant-sparking-hare/.claude/commands/linear-project.md +70 -0
- package/dist/claude-config/worktrees/valiant-sparking-hare/.claude/settings.json +13 -0
- package/dist/claude-config/worktrees/valiant-sparking-hare/.claude/skills/doc-drift-check/SKILL.md +140 -0
- package/dist/claude-config/worktrees/valiant-sparking-hare/.claude/skills/doc-drift-check/references/severity-guide.md +174 -0
- package/dist/claude-config/worktrees/valiant-sparking-hare/.github/workflows/claude-code-review.yml +32 -0
- package/dist/claude-config/worktrees/valiant-sparking-hare/.github/workflows/claude.yml +37 -0
- package/dist/claude-config/worktrees/valiant-sparking-hare/.nvmrc +1 -0
- package/dist/claude-config/worktrees/valiant-sparking-hare/.prettierignore +11 -0
- package/dist/index.d.ts +2 -0
- package/dist/index.js +653 -0
- package/dist/index.js.map +1 -0
- package/package.json +46 -0
|
@@ -0,0 +1,174 @@
|
|
|
1
|
+
# Severity Classification Guide
|
|
2
|
+
|
|
3
|
+
Detailed guide for categorizing doc drift findings by severity level. Use this when analyzing mismatches between code changes and documentation.
|
|
4
|
+
|
|
5
|
+
## π΄ Critical β Would Cause Wrong Assumptions
|
|
6
|
+
|
|
7
|
+
These mismatches would cause someone to build against incorrect assumptions or make wrong decisions.
|
|
8
|
+
|
|
9
|
+
### Model/Schema Changes
|
|
10
|
+
|
|
11
|
+
- Code adds a new model but the Notion module page doesn't list it
|
|
12
|
+
- Code removes or renames a model field, but the module documentation still references the old field
|
|
13
|
+
- Relationship between models changed (e.g., ForeignKey β ManyToMany) but not reflected in docs
|
|
14
|
+
- New required field added to a model but not documented in the module's models section
|
|
15
|
+
|
|
16
|
+
**Example:**
|
|
17
|
+
> Code adds `AccessKey` model to `andgate_crypto` module, but the Crypto module page in Notion under Platform's Product Development doesn't mention it.
|
|
18
|
+
|
|
19
|
+
### API/Endpoint Changes
|
|
20
|
+
|
|
21
|
+
- New endpoint added without documentation
|
|
22
|
+
- Endpoint removed but still listed in docs
|
|
23
|
+
- Request/response format changed but docs show old format
|
|
24
|
+
- Authentication requirements changed
|
|
25
|
+
|
|
26
|
+
### Environment & Configuration
|
|
27
|
+
|
|
28
|
+
- New environment variable required but not in CLAUDE.md or deployment docs
|
|
29
|
+
- Configuration option removed but still documented
|
|
30
|
+
- Default value changed for existing config
|
|
31
|
+
|
|
32
|
+
### Architecture Changes
|
|
33
|
+
|
|
34
|
+
- New module/app created without corresponding Notion documentation
|
|
35
|
+
- Service dependencies changed (module A now depends on module B, but docs don't show this)
|
|
36
|
+
- Database migration adds/removes tables not reflected in schema docs
|
|
37
|
+
|
|
38
|
+
---
|
|
39
|
+
|
|
40
|
+
## π‘ Moderate β Would Miss Important Capabilities
|
|
41
|
+
|
|
42
|
+
These mismatches would cause someone to miss important features or follow outdated procedures.
|
|
43
|
+
|
|
44
|
+
### Service Changes
|
|
45
|
+
|
|
46
|
+
- New service class added to a module but module page doesn't list it in the services section
|
|
47
|
+
- Service method signature changed (different params) but process docs reference old signature
|
|
48
|
+
- Service now calls a different external provider but process diagrams show old flow
|
|
49
|
+
|
|
50
|
+
**Example:**
|
|
51
|
+
> Code adds `AccessKeyService` to handle crypto signing, but the Crypto module page doesn't list it under Services.
|
|
52
|
+
|
|
53
|
+
### Process Flow Changes
|
|
54
|
+
|
|
55
|
+
- Steps in a business process reordered or modified
|
|
56
|
+
- New step added to a process (e.g., new validation step in onboarding)
|
|
57
|
+
- Conditional logic changed (e.g., different handling for B2B vs B2C)
|
|
58
|
+
- Process now has prerequisites that aren't documented
|
|
59
|
+
|
|
60
|
+
**Example:**
|
|
61
|
+
> Customer onboarding now requires provider-specific KYC before account creation, but the process page still shows a single KYC step.
|
|
62
|
+
|
|
63
|
+
### Feature Documentation Gaps
|
|
64
|
+
|
|
65
|
+
- New feature implemented but no feature document exists
|
|
66
|
+
- Feature behavior changed significantly but feature docs describe old behavior
|
|
67
|
+
- Feature flag added without documentation in relevant places
|
|
68
|
+
|
|
69
|
+
### Workflow Changes
|
|
70
|
+
|
|
71
|
+
- Webhook handling changed but webhook documentation outdated
|
|
72
|
+
- Background task behavior modified but not reflected in process docs
|
|
73
|
+
- Error handling strategy changed for a module
|
|
74
|
+
|
|
75
|
+
---
|
|
76
|
+
|
|
77
|
+
## π’ Light β Brief Confusion Only
|
|
78
|
+
|
|
79
|
+
These mismatches would cause someone brief confusion but wouldn't lead to incorrect work.
|
|
80
|
+
|
|
81
|
+
### Naming/Renaming
|
|
82
|
+
|
|
83
|
+
- Service or utility class renamed but docs use old name
|
|
84
|
+
- File moved to different directory but docs reference old path
|
|
85
|
+
- Variable or constant renamed
|
|
86
|
+
|
|
87
|
+
**Example:**
|
|
88
|
+
> `CryptoSigningService` renamed to `AccessKeyService` in code but Notion module page still says `CryptoSigningService`.
|
|
89
|
+
|
|
90
|
+
### Outdated Examples
|
|
91
|
+
|
|
92
|
+
- Code example in docs uses old import path
|
|
93
|
+
- Example shows deprecated API usage but functionally equivalent
|
|
94
|
+
- Test examples reference old fixtures
|
|
95
|
+
|
|
96
|
+
### Minor Wording
|
|
97
|
+
|
|
98
|
+
- Documentation says "will be implemented" for already-implemented features
|
|
99
|
+
- Status markers (TODO, WIP) left in docs for completed work
|
|
100
|
+
- Comments in code reference old Notion page names
|
|
101
|
+
|
|
102
|
+
---
|
|
103
|
+
|
|
104
|
+
## Per-Source Analysis Guide
|
|
105
|
+
|
|
106
|
+
### Notion Module Pages
|
|
107
|
+
|
|
108
|
+
Module pages describe models and services for each module. When checking:
|
|
109
|
+
|
|
110
|
+
1. **Models section** β Compare listed models against actual Django models in the code
|
|
111
|
+
2. **Services section** β Compare listed services against actual service classes
|
|
112
|
+
3. **API section** β Compare listed endpoints against actual URL configs
|
|
113
|
+
4. **Shared models** β Verify cross-module dependencies are still accurate
|
|
114
|
+
5. **Dependency graph** β Check if module interdependencies changed
|
|
115
|
+
|
|
116
|
+
### Notion Processes Database
|
|
117
|
+
|
|
118
|
+
Process pages describe business workflows. When checking:
|
|
119
|
+
|
|
120
|
+
1. **Process steps** β Do the documented steps match the actual code flow?
|
|
121
|
+
2. **Prerequisites** β Are process prerequisites still accurate?
|
|
122
|
+
3. **Provider interactions** β Do provider-specific flows match current implementation?
|
|
123
|
+
4. **Status transitions** β Do documented state machines match code?
|
|
124
|
+
5. **Related modules** β Is the "ΠΠΎΠ΄ΡΠ»ΠΈ" relation still correct?
|
|
125
|
+
|
|
126
|
+
### Repository docs/ Directory
|
|
127
|
+
|
|
128
|
+
Local documentation files. When checking:
|
|
129
|
+
|
|
130
|
+
1. **Architecture docs** β Do they reflect current module structure?
|
|
131
|
+
2. **API docs** β Do endpoint descriptions match implementations?
|
|
132
|
+
3. **Setup/deployment docs** β Are instructions still accurate?
|
|
133
|
+
|
|
134
|
+
### CLAUDE.md
|
|
135
|
+
|
|
136
|
+
Project-level documentation. When checking:
|
|
137
|
+
|
|
138
|
+
1. **Environment variables table** β All required vars listed?
|
|
139
|
+
2. **Project structure** β Does the tree match actual directory layout?
|
|
140
|
+
3. **Technology stack** β Any new dependencies or tools?
|
|
141
|
+
4. **Key documentation links** β Do referenced docs still exist?
|
|
142
|
+
|
|
143
|
+
### Database Schema
|
|
144
|
+
|
|
145
|
+
Schema documentation. When checking:
|
|
146
|
+
|
|
147
|
+
1. **Table definitions** β Do they match current migrations?
|
|
148
|
+
2. **Relationships** β Are FK/M2M relations documented correctly?
|
|
149
|
+
3. **Indexes** β Any new indexes not mentioned in schema docs?
|
|
150
|
+
4. **New tables** β Any new migrations creating tables not in schema docs?
|
|
151
|
+
|
|
152
|
+
---
|
|
153
|
+
|
|
154
|
+
## Edge Cases
|
|
155
|
+
|
|
156
|
+
### When NOT to Flag
|
|
157
|
+
|
|
158
|
+
- Code comments that are slightly outdated (not worth a Linear comment)
|
|
159
|
+
- Test file documentation being slightly behind (tests are self-documenting)
|
|
160
|
+
- Third-party library version bumps with no behavior change
|
|
161
|
+
- Formatting-only changes to documentation files
|
|
162
|
+
- Internal refactoring that doesn't change public interfaces or behavior
|
|
163
|
+
|
|
164
|
+
### When to Escalate to Critical
|
|
165
|
+
|
|
166
|
+
Even if a change seems small, escalate if:
|
|
167
|
+
- It affects an external-facing API that developers build against
|
|
168
|
+
- It changes model fields that other services query
|
|
169
|
+
- It modifies environment variables needed for deployment
|
|
170
|
+
- It alters the behavior described in a process that operations follows
|
|
171
|
+
|
|
172
|
+
### Multiple Small Issues
|
|
173
|
+
|
|
174
|
+
If there are many Light issues (5+) concentrated in one documentation area, consider grouping them and elevating to a single Moderate finding with a suggestion to do a documentation review for that area.
|
package/dist/claude-config/worktrees/valiant-sparking-hare/.github/workflows/claude-code-review.yml
ADDED
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
name: Claude Code Review
|
|
2
|
+
|
|
3
|
+
on:
|
|
4
|
+
pull_request:
|
|
5
|
+
types: [opened, synchronize, ready_for_review, reopened]
|
|
6
|
+
|
|
7
|
+
jobs:
|
|
8
|
+
claude-review:
|
|
9
|
+
runs-on: ubuntu-latest
|
|
10
|
+
permissions:
|
|
11
|
+
contents: write
|
|
12
|
+
pull-requests: write
|
|
13
|
+
issues: write
|
|
14
|
+
id-token: write
|
|
15
|
+
|
|
16
|
+
steps:
|
|
17
|
+
- name: Checkout repository
|
|
18
|
+
uses: actions/checkout@v4
|
|
19
|
+
with:
|
|
20
|
+
fetch-depth: 1
|
|
21
|
+
|
|
22
|
+
- name: Run Claude Code Review
|
|
23
|
+
id: claude-review
|
|
24
|
+
uses: anthropics/claude-code-action@v1
|
|
25
|
+
with:
|
|
26
|
+
claude_code_oauth_token: ${{ secrets.CLAUDE_CODE_OAUTH_TOKEN }}
|
|
27
|
+
plugin_marketplaces: 'https://github.com/anthropics/claude-code.git'
|
|
28
|
+
plugins: 'code-review@claude-code-plugins'
|
|
29
|
+
prompt: '/code-review:code-review ${{ github.repository }}/pull/${{ github.event.pull_request.number }}'
|
|
30
|
+
# See https://github.com/anthropics/claude-code-action/blob/main/docs/usage.md
|
|
31
|
+
# or https://code.claude.com/docs/en/cli-reference for available options
|
|
32
|
+
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
name: Claude Code
|
|
2
|
+
|
|
3
|
+
on:
|
|
4
|
+
issue_comment:
|
|
5
|
+
types: [created]
|
|
6
|
+
pull_request_review_comment:
|
|
7
|
+
types: [created]
|
|
8
|
+
issues:
|
|
9
|
+
types: [opened, assigned]
|
|
10
|
+
pull_request_review:
|
|
11
|
+
types: [submitted]
|
|
12
|
+
|
|
13
|
+
jobs:
|
|
14
|
+
claude:
|
|
15
|
+
if: |
|
|
16
|
+
(github.event_name == 'issue_comment' && contains(github.event.comment.body, '@claude')) ||
|
|
17
|
+
(github.event_name == 'pull_request_review_comment' && contains(github.event.comment.body, '@claude')) ||
|
|
18
|
+
(github.event_name == 'pull_request_review' && contains(github.event.review.body, '@claude')) ||
|
|
19
|
+
(github.event_name == 'issues' && (contains(github.event.issue.body, '@claude') || contains(github.event.issue.title, '@claude')))
|
|
20
|
+
runs-on: ubuntu-latest
|
|
21
|
+
permissions:
|
|
22
|
+
contents: write
|
|
23
|
+
pull-requests: write
|
|
24
|
+
issues: write
|
|
25
|
+
id-token: write
|
|
26
|
+
actions: read # Required for Claude to read CI results on PRs
|
|
27
|
+
steps:
|
|
28
|
+
- name: Checkout repository
|
|
29
|
+
uses: actions/checkout@v4
|
|
30
|
+
with:
|
|
31
|
+
fetch-depth: 1
|
|
32
|
+
|
|
33
|
+
- name: Run Claude Code
|
|
34
|
+
id: claude
|
|
35
|
+
uses: anthropics/claude-code-action@v1
|
|
36
|
+
with:
|
|
37
|
+
claude_code_oauth_token: ${{ secrets.CLAUDE_CODE_OAUTH_TOKEN }}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
v22.18.0
|
package/dist/index.d.ts
ADDED