ralph-prd 1.0.4 → 1.0.6
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 +16 -2
- package/bin/install.mjs +42 -29
- package/package.json +1 -2
- package/ralph/lib/config.mjs +9 -8
- package/ralph/lib/ship-checker.mjs +319 -0
- package/ralph/lib/verifier.mjs +1 -1
- package/ralph/ralph-claude.mjs +70 -2
- package/ralph/ralph.config.sample.yaml +10 -5
- package/ralph/test/ship-checker.test.mjs +268 -0
- package/skills/grill-me/SKILL.md +0 -10
- package/skills/grill-me/agents/openai.yaml +0 -4
- package/skills/prd-to-plan/SKILL.md +0 -107
- package/skills/prd-to-plan/agents/openai.yaml +0 -4
- package/skills/repo-doc-maintainer/SKILL.md +0 -101
- package/skills/repo-doc-maintainer/agents/openai.yaml +0 -4
- package/skills/repo-doc-maintainer/references/doc-update-criteria.md +0 -32
- package/skills/review-changes/SKILL.md +0 -90
- package/skills/review-changes/agents/openai.yaml +0 -4
- package/skills/review-changes/references/review-checklist.md +0 -37
- package/skills/ship-check/SKILL.md +0 -80
- package/skills/ship-check/agents/openai.yaml +0 -4
- package/skills/ship-check/references/validation-flow.md +0 -26
- package/skills/write-a-prd/SKILL.md +0 -74
- package/skills/write-a-prd/agents/openai.yaml +0 -4
|
@@ -1,80 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
name: ship-check
|
|
3
|
-
description: Run the standard post-change validation flow after a fix, refactor, or new feature. Use when implementation work is done and you should validate the latest changes by invoking the repo's review skills, starting with review-changes and then repo-doc-maintainer, before giving the final close-out.
|
|
4
|
-
disable-model-invocation: true
|
|
5
|
-
---
|
|
6
|
-
|
|
7
|
-
# Ship Check
|
|
8
|
-
|
|
9
|
-
## Overview
|
|
10
|
-
|
|
11
|
-
Run the repo's end-of-task validation flow after code or documentation changes.
|
|
12
|
-
|
|
13
|
-
This is an orchestration skill. It does not replace the specialized review skills. It tells the agent which checks to run, in what order, and how to summarize the result before final handoff.
|
|
14
|
-
|
|
15
|
-
## Standard Flow
|
|
16
|
-
|
|
17
|
-
Use this flow after finishing a fix, refactor, or feature:
|
|
18
|
-
|
|
19
|
-
1. Review the latest changes with `$review-changes`.
|
|
20
|
-
2. Check whether project documentation needs maintenance with `$repo-doc-maintainer`.
|
|
21
|
-
3. Report the combined outcome clearly.
|
|
22
|
-
4. If code changed, remind the user about any validation commands not yet run.
|
|
23
|
-
|
|
24
|
-
## Invocation Pattern
|
|
25
|
-
|
|
26
|
-
When this skill is invoked, explicitly use the other repo-local skills in sequence.
|
|
27
|
-
|
|
28
|
-
Start with:
|
|
29
|
-
|
|
30
|
-
`Use $review-changes to review the latest changes against the project's guidelines and report findings first.`
|
|
31
|
-
|
|
32
|
-
Then run:
|
|
33
|
-
|
|
34
|
-
`Use $repo-doc-maintainer to review the latest changes and decide whether project documentation should be updated.`
|
|
35
|
-
|
|
36
|
-
Do not skip either step unless the user explicitly narrows the scope.
|
|
37
|
-
|
|
38
|
-
## How To Interpret Results
|
|
39
|
-
|
|
40
|
-
### If `review-changes` finds issues
|
|
41
|
-
|
|
42
|
-
- present the findings first
|
|
43
|
-
- do not claim the work is validated
|
|
44
|
-
- if the issues are actionable and local, fix them before final handoff when appropriate
|
|
45
|
-
- rerun validation after fixes if you changed the code again
|
|
46
|
-
|
|
47
|
-
### If `review-changes` finds no issues
|
|
48
|
-
|
|
49
|
-
- say that the changes comply with the current repo guidance
|
|
50
|
-
- still run `$repo-doc-maintainer`
|
|
51
|
-
|
|
52
|
-
### If `repo-doc-maintainer` says docs should change
|
|
53
|
-
|
|
54
|
-
- update the docs if the current task includes making those maintenance edits
|
|
55
|
-
- otherwise report that documentation maintenance is recommended
|
|
56
|
-
|
|
57
|
-
### If `repo-doc-maintainer` says no doc update is needed
|
|
58
|
-
|
|
59
|
-
- state that explicitly in the final close-out
|
|
60
|
-
|
|
61
|
-
## Output Expectations
|
|
62
|
-
|
|
63
|
-
The final close-out should combine both checks:
|
|
64
|
-
|
|
65
|
-
- whether the implementation passed the repo-rule review
|
|
66
|
-
- whether documentation maintenance was needed
|
|
67
|
-
- whether project validation commands were run or remain outstanding
|
|
68
|
-
|
|
69
|
-
Keep the output compact. Prefer a brief status summary over a long checklist unless there are actual findings.
|
|
70
|
-
|
|
71
|
-
## Constraints
|
|
72
|
-
|
|
73
|
-
- Treat `$review-changes` as the source of truth for repo-rule compliance review.
|
|
74
|
-
- Treat `$repo-doc-maintainer` as the source of truth for doc-maintenance decisions.
|
|
75
|
-
- Do not invent a separate third review rubric here.
|
|
76
|
-
- Use this skill at the end of work, not before implementation starts.
|
|
77
|
-
|
|
78
|
-
## Reference
|
|
79
|
-
|
|
80
|
-
Read [references/validation-flow.md](references/validation-flow.md) if you need the exact end-of-task checklist.
|
|
@@ -1,26 +0,0 @@
|
|
|
1
|
-
# Validation Flow
|
|
2
|
-
|
|
3
|
-
Use this checklist after finishing implementation work.
|
|
4
|
-
|
|
5
|
-
## Required Review Skills
|
|
6
|
-
|
|
7
|
-
1. `$review-changes`
|
|
8
|
-
2. `$repo-doc-maintainer`
|
|
9
|
-
|
|
10
|
-
## Default Sequence
|
|
11
|
-
|
|
12
|
-
1. Inspect the latest working tree or commit range.
|
|
13
|
-
2. Run the repo-rule review via `$review-changes`.
|
|
14
|
-
3. Run the doc-maintenance review via `$repo-doc-maintainer`.
|
|
15
|
-
4. Summarize both results.
|
|
16
|
-
|
|
17
|
-
## Final Close-Out Should Cover
|
|
18
|
-
|
|
19
|
-
- whether the changes respect the project's documented guidelines
|
|
20
|
-
- whether project documentation needed updates
|
|
21
|
-
- whether validation commands (lint, test, analyze) were run
|
|
22
|
-
- any residual risks, such as unrun tests or manual-only verification gaps
|
|
23
|
-
|
|
24
|
-
## When To Re-Run
|
|
25
|
-
|
|
26
|
-
Re-run the flow if you make additional code or doc edits after the first validation pass.
|
|
@@ -1,74 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
name: write-a-prd
|
|
3
|
-
description: Create a PRD through user interview, codebase exploration, and module design, then submit as a GitHub issue. Use when user wants to write a PRD, create a product requirements document, or plan a new feature.
|
|
4
|
-
---
|
|
5
|
-
|
|
6
|
-
This skill will be invoked when the user wants to create a PRD in ./docs/<feature-name>/PRD.md. You may skip steps if you don't consider them necessary.
|
|
7
|
-
|
|
8
|
-
1. Ask the user for a long, detailed description of the problem they want to solve and any potential ideas for solutions.
|
|
9
|
-
|
|
10
|
-
2. Explore the repo to verify their assertions and understand the current state of the codebase.
|
|
11
|
-
|
|
12
|
-
3. Interview the user relentlessly about every aspect of this plan until you reach a shared understanding. Walk down each branch of the design tree, resolving dependencies between decisions one-by-one.
|
|
13
|
-
|
|
14
|
-
4. Sketch out the major modules you will need to build or modify to complete the implementation. Actively look for opportunities to extract deep modules that can be tested in isolation.
|
|
15
|
-
|
|
16
|
-
A deep module (as opposed to a shallow module) is one which encapsulates a lot of functionality in a simple, testable interface which rarely changes.
|
|
17
|
-
|
|
18
|
-
Check with the user that these modules match their expectations. Check with the user which modules they want tests written for.
|
|
19
|
-
|
|
20
|
-
5. Once you have a complete understanding of the problem and solution, use the template below to write the PRD. The PRD should be submitted as a GitHub issue.
|
|
21
|
-
|
|
22
|
-
<prd-template>
|
|
23
|
-
|
|
24
|
-
## Problem Statement
|
|
25
|
-
|
|
26
|
-
The problem that the user is facing, from the user's perspective.
|
|
27
|
-
|
|
28
|
-
## Solution
|
|
29
|
-
|
|
30
|
-
The solution to the problem, from the user's perspective.
|
|
31
|
-
|
|
32
|
-
## User Stories
|
|
33
|
-
|
|
34
|
-
A LONG, numbered list of user stories. Each user story should be in the format of:
|
|
35
|
-
|
|
36
|
-
1. As an <actor>, I want a <feature>, so that <benefit>
|
|
37
|
-
|
|
38
|
-
<user-story-example>
|
|
39
|
-
1. As a mobile bank customer, I want to see balance on my accounts, so that I can make better informed decisions about my spending
|
|
40
|
-
</user-story-example>
|
|
41
|
-
|
|
42
|
-
This list of user stories should be extremely extensive and cover all aspects of the feature.
|
|
43
|
-
|
|
44
|
-
## Implementation Decisions
|
|
45
|
-
|
|
46
|
-
A list of implementation decisions that were made. This can include:
|
|
47
|
-
|
|
48
|
-
- The modules that will be built/modified
|
|
49
|
-
- The interfaces of those modules that will be modified
|
|
50
|
-
- Technical clarifications from the developer
|
|
51
|
-
- Architectural decisions
|
|
52
|
-
- Schema changes
|
|
53
|
-
- API contracts
|
|
54
|
-
- Specific interactions
|
|
55
|
-
|
|
56
|
-
Do NOT include specific file paths or code snippets. They may end up being outdated very quickly.
|
|
57
|
-
|
|
58
|
-
## Testing Decisions
|
|
59
|
-
|
|
60
|
-
A list of testing decisions that were made. Include:
|
|
61
|
-
|
|
62
|
-
- A description of what makes a good test (only test external behavior, not implementation details)
|
|
63
|
-
- Which modules will be tested
|
|
64
|
-
- Prior art for the tests (i.e. similar types of tests in the codebase)
|
|
65
|
-
|
|
66
|
-
## Out of Scope
|
|
67
|
-
|
|
68
|
-
A description of the things that are out of scope for this PRD.
|
|
69
|
-
|
|
70
|
-
## Further Notes
|
|
71
|
-
|
|
72
|
-
Any further notes about the feature.
|
|
73
|
-
|
|
74
|
-
</prd-template>
|