Skip to content

docs(#119): apply PR #112 follow-up doc fixes #130

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
devallibus wants to merge 2 commits into
base: master
Choose a base branch
from
Open

docs(#119): apply PR #112 follow-up doc fixes #130

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5f16d0f
docs(#119): apply PR #112 follow-up doc fixes
devallibus Mar 19, 2026
e0e697f
docs(#119): align brainstorm triage example with template tasks
devallibus Mar 19, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions skills/shiplog/brainstorm.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ description: "Phase 1: Capture brainstorming output as a GitHub issue with struc
- **Internal claims** about this repository's code, tests, configuration, or committed docs can be verified from the repo itself.
- **External claims** about third-party tools, URLs, APIs, platform capabilities must be verified against primary sources before they are stated as facts.
- If an external claim cannot be verified yet, keep it explicitly marked as `[unverified]` and treat it as a hypothesis, not settled input.
- Do not turn an unverified claim into a task requirement, acceptance criterion, or architectural decision without a verification step.

3. **Quiet Mode: defer capture.** Do not create the `--log` PR yet — the feature branch does not exist until branch setup. Save the brainstorm content locally and use it as the opening entry when the `--log` PR is created.

Expand All @@ -43,6 +44,10 @@ Issue body content:
kind: state
status: open
phase: 1
readiness: needs-design
task_count: 2
tasks_complete: 0
max_tier: tier-1
updated_at: <ISO_TIMESTAMP>
-->

Expand Down
2 changes: 1 addition & 1 deletion skills/shiplog/references/artifact-envelopes.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ Use triage fields on issue-body `state` envelopes so agents can rank work withou
- **`updated_by`:** normalized like the signature body without the role prefix — e.g., `openai/gpt-5.4 (codex, effort: high)`.
- **`edit_kind`:** use `correction` for factual or signature fixes, `amendment` for clarifications that preserve the original event, `rewrite` for substantial in-place rewrites, and `cosmetic` only when recording a non-semantic cleanup intentionally.
- **Amendment/supersession references:** use the same `<artifact-location>#<kind>` format for `amends`, `supersedes`, and `superseded_by`.
- **Supersession references:** `<artifact-location>#<kind>` - e.g., `issue/42#state` or `pr/55#verification`. See Section 3 for resolution.
- **Supersession references:** `<artifact-location>#<kind>` - e.g., `issue/42#state` or `pr/55#verification`. See �3 for resolution.
- **Triage integers:** use bare integers, not quoted strings.
- **`readiness`:** use only `ready`, `blocked`, `needs-design`, `in-progress`, or `done`.
- **`max_tier`:** use `tier-1`, `tier-2`, or `tier-3`; omit it when all tasks are complete.
Expand Down