codeassembly-guidance 0.0.0 → 0.1.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/.meta/changelog.json +563 -0
- package/CHANGELOG.md +134 -0
- package/LICENSE +7 -0
- package/README.md +165 -1
- package/content/_partials/README.md +192 -0
- package/content/_partials/code-descriptions.md +4 -0
- package/content/_partials/code-style.md +7 -0
- package/content/_partials/comment-discipline.md +89 -0
- package/content/_partials/concision.md +3 -0
- package/content/_partials/diff-audit-checklist.md +9 -0
- package/content/_partials/file-access.md +4 -0
- package/content/_partials/live-repo-writes.md +13 -0
- package/content/_partials/plain-speech-calibration.md +66 -0
- package/content/_partials/plain-speech.md +13 -0
- package/content/_partials/prose-line-breaks.md +3 -0
- package/content/_partials/record-marker.md +1 -0
- package/content/_partials/reduced-object-relative.md +28 -0
- package/content/_partials/shell-commands.md +3 -0
- package/content/_partials/target-file-set-resolution.md +22 -0
- package/content/_partials/technical-recommendations.md +5 -0
- package/content/_partials/test-structure-audit-checklist.md +7 -0
- package/content/_partials/ticket-assessment-baseline.md +12 -0
- package/content/_partials/ticket-assessment.md +202 -0
- package/content/_partials/work-type-choice.md +13 -0
- package/content/codeassembly-content.yaml +49 -0
- package/content/collections/all.md +11 -0
- package/content/collections/atlassian.md +16 -0
- package/content/collections/recommended.md +34 -0
- package/content/collections/triage.md +77 -0
- package/content/collections/williamthorsen.md +25 -0
- package/content/guidance/README.md +22 -0
- package/content/guidance/_harnesses/claude/CLAUDE.md +6 -0
- package/content/guidance/_harnesses/rovo/AGENTS.md +5 -0
- package/content/guidance/_harnesses/rovo/codeassembly-guidance.md +4 -0
- package/content/guidance/rulebooks/accessibility-conventions.md +20 -0
- package/content/guidance/rulebooks/codeassembly-content-specification.md +161 -0
- package/content/guidance/rulebooks/command-output-conventions.md +14 -0
- package/content/guidance/rulebooks/commit-conventions.md +72 -0
- package/content/guidance/rulebooks/generated-content-policy.md +10 -0
- package/content/guidance/rulebooks/live-worktree-policy.md +18 -0
- package/content/guidance/rulebooks/readme-conventions.md +74 -0
- package/content/guidance/rulebooks/shared-data-conventions.md +14 -0
- package/content/guidance/rulebooks/shell-conventions.md +279 -0
- package/content/guidance/rulebooks/williamthorsen-code-layout-preferences.md +102 -0
- package/content/guidance/rulebooks/williamthorsen-collaboration-preferences.md +58 -0
- package/content/guidance/rulebooks/williamthorsen-comment-preferences.md +30 -0
- package/content/guidance/rulebooks/williamthorsen-subagent-model-preferences.md +15 -0
- package/content/guidance/rulebooks/williamthorsen-ticketing-preferences.md +22 -0
- package/content/guidance/rulebooks/williamthorsen-tooling-preferences.md +36 -0
- package/content/guidance/rulebooks/williamthorsen-typescript-preferences.md +90 -0
- package/content/guidance/rulebooks/williamthorsen-workflow-preferences.md +58 -0
- package/content/guidance/rulebooks/williamthorsen-writing-preferences.md +80 -0
- package/content/guidance/shared/AGENTS.md +43 -0
- package/content/scripts/README.md +41 -0
- package/content/scripts/describe-change.mjs +165 -0
- package/content/scripts/get-ticket-id.sh +131 -0
- package/content/scripts/manage-jira-ticket.mjs +209 -0
- package/content/scripts/resolve-frontmatter.sh +540 -0
- package/content/scripts/resolve-review-run.mjs +12 -0
- package/content/scripts/select-lede-exemplars.mjs +208 -0
- package/content/skills/_data/action-items.md +83 -0
- package/content/skills/_data/artifact-conventions.md +969 -0
- package/content/skills/_data/bitbucket-pr-access.md +89 -0
- package/content/skills/_data/branch-format.md +34 -0
- package/content/skills/_data/change-record.md +163 -0
- package/content/skills/_data/complexity-classification.md +58 -0
- package/content/skills/_data/concision.md +23 -0
- package/content/skills/_data/deployed-file-provenance.md +46 -0
- package/content/skills/_data/design-priorities.md +76 -0
- package/content/skills/_data/gh-body-file.md +30 -0
- package/content/skills/_data/git-commands.md +39 -0
- package/content/skills/_data/naming-conventions.md +50 -0
- package/content/skills/_data/pr-resolution.md +25 -0
- package/content/skills/_data/pr-source-resolution.md +36 -0
- package/content/skills/_data/recommendation-gradient.md +90 -0
- package/content/skills/_data/scope-and-deferral.md +83 -0
- package/content/skills/_data/spike-conventions.md +89 -0
- package/content/skills/_data/ticket-evaluation.md +13 -0
- package/content/skills/_data/ticket-id-extraction.md +43 -0
- package/content/skills/_data/ticket-source-resolution.md +147 -0
- package/content/skills/_data/title-templates.md +624 -0
- package/content/skills/_data/title-voice.md +17 -0
- package/content/skills/_data/work-types.json +168 -0
- package/content/skills/_partials/acceptance-criteria-scaffold.md +15 -0
- package/content/skills/_partials/action-items.md +22 -0
- package/content/skills/_partials/bitbucket-delete-both-refusal.md +3 -0
- package/content/skills/_partials/commit-title-rendering.md +14 -0
- package/content/skills/_partials/gh-body-file.md +22 -0
- package/content/skills/_partials/nested-list-indent.md +9 -0
- package/content/skills/_partials/next-steps-after-plan.md +99 -0
- package/content/skills/_partials/next-steps-after-review.md +350 -0
- package/content/skills/_partials/option-format.md +84 -0
- package/content/skills/_partials/plan-template.md +97 -0
- package/content/skills/_partials/split-launch-prompts.md +5 -0
- package/content/skills/_partials/split-ticket-compose.md +5 -0
- package/content/skills/_partials/split-ticket-create.md +3 -0
- package/content/skills/_partials/ticket-and-plan-completeness.md +33 -0
- package/content/skills/_partials/ticket-concision.md +18 -0
- package/content/skills/_partials/ticket-criteria-conventions.md +7 -0
- package/content/skills/_partials/ticket-placement.md +14 -0
- package/content/skills/_partials/ticket-skeleton-tiers.md +6 -0
- package/content/skills/_partials/ticket-skeleton.md +13 -0
- package/content/skills/add-change-record/SKILL.md +136 -0
- package/content/skills/add-test-ids/SKILL.md +51 -0
- package/content/skills/align-ticket-with-implementation/SKILL.md +115 -0
- package/content/skills/anti-patterns/SKILL.md +57 -0
- package/content/skills/assess-ticket/SKILL.md +46 -0
- package/content/skills/assess-ticket/next-steps-after-assessment.md +98 -0
- package/content/skills/brainstorming/SKILL.md +107 -0
- package/content/skills/capture-event/SKILL.md +108 -0
- package/content/skills/capture-event/capture-event.mjs +216 -0
- package/content/skills/capture-feedback/SKILL.md +71 -0
- package/content/skills/capture-lede-decision/SKILL.md +163 -0
- package/content/skills/capture-lede-decision/capture-lede-decision.mjs +231 -0
- package/content/skills/classify-complexity/SKILL.md +92 -0
- package/content/skills/collaborate/SKILL.md +86 -0
- package/content/skills/condense-branch/SKILL.md +83 -0
- package/content/skills/create-bitbucket-pr/SKILL.md +87 -0
- package/content/skills/create-commit/SKILL.md +65 -0
- package/content/skills/create-devlog/SKILL.md +108 -0
- package/content/skills/create-gh-pr/SKILL.md +106 -0
- package/content/skills/create-pr/SKILL.md +150 -0
- package/content/skills/create-ticket/SKILL.md +350 -0
- package/content/skills/derive-session-context/derive-session-context.mjs +148 -0
- package/content/skills/design-and-plan/SKILL.md +194 -0
- package/content/skills/development-workflows/SKILL.md +41 -0
- package/content/skills/get-ticket-id/SKILL.md +67 -0
- package/content/skills/groom-backlog/SKILL.md +245 -0
- package/content/skills/groom-backlog/groom-backlog.mjs +106 -0
- package/content/skills/implement-plan/SKILL.md +164 -0
- package/content/skills/index-prototypes/SKILL.md +145 -0
- package/content/skills/index-prototypes/index-prototypes.mjs +328 -0
- package/content/skills/kb-add/SKILL.md +156 -0
- package/content/skills/kb-add/kb-add.mjs +216 -0
- package/content/skills/kb-curate/SKILL.md +117 -0
- package/content/skills/kb-curate/kb-curate.mjs +213 -0
- package/content/skills/kb-edit/SKILL.md +128 -0
- package/content/skills/kb-edit/kb-edit.mjs +219 -0
- package/content/skills/kb-retrieve/SKILL.md +100 -0
- package/content/skills/kb-retrieve/kb-retrieve.mjs +206 -0
- package/content/skills/kb-retrieve-events/SKILL.md +98 -0
- package/content/skills/kb-retrieve-events/kb-retrieve-events.mjs +206 -0
- package/content/skills/kb-update-events/SKILL.md +77 -0
- package/content/skills/kb-update-events/kb-update-events.mjs +215 -0
- package/content/skills/merge-bb-pr/SKILL.md +136 -0
- package/content/skills/merge-gh-pr/SKILL.md +167 -0
- package/content/skills/merge-gh-pr/merge-gh-pr.mjs +10 -0
- package/content/skills/merge-pr/SKILL.md +368 -0
- package/content/skills/migrate-feedback-memories/SKILL.md +136 -0
- package/content/skills/migrate-feedback-memories/feedback-memories.mjs +161 -0
- package/content/skills/people-report/SKILL.md +208 -0
- package/content/skills/plan/SKILL.md +87 -0
- package/content/skills/prepare-prototype-brief/SKILL.md +126 -0
- package/content/skills/pull-from-backlog/SKILL.md +83 -0
- package/content/skills/pull-from-backlog/pull-from-backlog.mjs +208 -0
- package/content/skills/refine-plan/SKILL.md +259 -0
- package/content/skills/respond-to-review/SKILL.md +292 -0
- package/content/skills/review-bb-pr/SKILL.md +161 -0
- package/content/skills/review-branch/SKILL.md +301 -0
- package/content/skills/review-criteria/SKILL.md +108 -0
- package/content/skills/review-gh-pr/SKILL.md +155 -0
- package/content/skills/review-gh-pr/select-pr-ticket.mjs +8 -0
- package/content/skills/review-permissions/SKILL.md +39 -0
- package/content/skills/review-pr/SKILL.md +123 -0
- package/content/skills/revise-comments/SKILL.md +115 -0
- package/content/skills/revise-prose/SKILL.md +197 -0
- package/content/skills/revise-prose/revise-prose.mjs +229 -0
- package/content/skills/save-artifact/SKILL.md +69 -0
- package/content/skills/save-plan/SKILL.md +55 -0
- package/content/skills/software-engineering/SKILL.md +74 -0
- package/content/skills/streamline-guidance/SKILL.md +174 -0
- package/content/skills/streamline-guidance/streamline-guidance.mjs +211 -0
- package/content/skills/summarize-change/SKILL.md +308 -0
- package/content/skills/summarize-chat/SKILL.md +100 -0
- package/content/skills/systematic-debugging/SKILL.md +308 -0
- package/content/skills/systematic-debugging/condition-based-waiting-example.ts +160 -0
- package/content/skills/systematic-debugging/condition-based-waiting.md +122 -0
- package/content/skills/systematic-debugging/defense-in-depth.md +130 -0
- package/content/skills/systematic-debugging/find-polluter.sh +68 -0
- package/content/skills/systematic-debugging/root-cause-tracing.md +185 -0
- package/content/skills/systematic-debugging/test-academic.md +16 -0
- package/content/skills/systematic-debugging/test-pressure-1.md +67 -0
- package/content/skills/systematic-debugging/test-pressure-2.md +77 -0
- package/content/skills/systematic-debugging/test-pressure-3.md +77 -0
- package/content/skills/testing-conventions/SKILL.md +168 -0
- package/content/skills/testing-conventions/mistakes.md +1 -0
- package/content/skills/typescript-testing-conventions/SKILL.md +129 -0
- package/content/skills/update-jira-ticket/SKILL.md +245 -0
- package/content/skills/update-jira-ticket/update-jira-ticket.mjs +9 -0
- package/content/skills/update-project-guidance/SKILL.md +300 -0
- package/content/skills/upgrade-dependencies/SKILL.md +139 -0
- package/content/skills/wrap-up/SKILL.md +431 -0
- package/content/subagents/_data/claude.yaml +19 -0
- package/content/subagents/_data/rovo.yaml +31 -0
- package/content/subagents/canary.md +11 -0
- package/content/subagents/entry-drafter.md +187 -0
- package/content/subagents/handoff-reviewer.md +75 -0
- package/content/subagents/plan-reviewer.md +184 -0
- package/content/subagents/plan-reviser.md +88 -0
- package/content/subagents/prose-reviser.md +130 -0
- package/content/subagents/ticket-assessor.md +139 -0
- package/package.json +70 -2
- package/schemas/preferences.v1.json +294 -0
- package/schemas/work-types.v1.json +142 -0
|
@@ -0,0 +1,130 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: prose-reviser
|
|
3
|
+
description: Revise one batch of files against the writing rule set, applying every clear repair and reporting the rest. Returns a structured report and does not commit.
|
|
4
|
+
tools: [Read, Edit, Grep, Glob]
|
|
5
|
+
maxTurns: 100
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
# Prose reviser
|
|
9
|
+
|
|
10
|
+
You revise the prose in one batch of files so that it follows the rules below, and you report what you did. You edit files. You never commit, and you never touch a file outside your batch.
|
|
11
|
+
|
|
12
|
+
## Your assignment
|
|
13
|
+
|
|
14
|
+
Your dispatch contains five scalars:
|
|
15
|
+
|
|
16
|
+
- **`root`**: The repository root. Every path below is relative to it.
|
|
17
|
+
- **`files`**: The files in your batch, comma-separated. This list is the whole set of files that you may edit.
|
|
18
|
+
- **`candidates`**: The path of a JSON file containing the detector's candidates for those files. Read it with {tool:Read}.
|
|
19
|
+
- **`rejections`**: The path of a JSON file containing the sites already adjudicated by an earlier sweep, each under one rule. Read it with {tool:Read}.
|
|
20
|
+
- **`rules`**: The ids of the rules that you apply to your batch, comma-separated.
|
|
21
|
+
|
|
22
|
+
Each candidate object contains `rule`, `file`, `line`, `phrase` (the span that a repair rewrites), and `sentence` (the whole sentence around it). An object-relative candidate also contains `shape`, `head`, `subject`, and `verb`. A `negative-quantifier` candidate also contains `positions`, which tags each determiner `no` in the sentence, in reading order, as `existential` (after "there is"), `relative` (the subject of a relative clause), or `other`. A `so` candidate also contains `trigger`: `bare` for a `so` that nothing before it marks as joining a result, which is usually a purpose clause missing "that", or `repeat` for a `so` in the same sentence as another or within three sentences after one. A candidate with `stale: true` was rejected by an earlier sweep, at a version of its rule that has since changed; adjudicate it afresh rather than carrying the old verdict over.
|
|
23
|
+
|
|
24
|
+
Each rejection object contains `rule`, `file`, and `phrase`. An earlier sweep judged that site under that rule and left it as it stands: Leave it under that rule too, and report nothing for it there. The entry settles only that one rule; therefore, a span named by the list is adjudicated normally under every other rule that you apply, and a site that also appears among the candidates is yours to judge under that candidate's rule. A site whose rule has changed version since is absent from the list; as a result, you receive it without any prior verdict at all.
|
|
25
|
+
|
|
26
|
+
Detection covers only those of your rules that have a detector, and it nominates sites rather than deciding them. The candidates tell you where to look first; they are not the assignment. Read each file in your batch whole and apply every rule that your `rules` scalar names to all of its prose.
|
|
27
|
+
|
|
28
|
+
An inline code span appears in a candidate's `sentence` as `«codespan»`, which stands for content that the detector elided so that its tokens do not read as prose. The source keeps the code. If the elided token decides the reading, read the source line.
|
|
29
|
+
|
|
30
|
+
## Which rules apply
|
|
31
|
+
|
|
32
|
+
The rules that your `rules` scalar names. This document states every rule in one of four places, which appear in this order: the plain-speech rule and its sweep calibration, both below, and the comment preferences and the writing preferences at the end. `plain-speech` names the first two together.
|
|
33
|
+
|
|
34
|
+
Do not apply any rule that your `rules` scalar leaves out, and do not report any site under one. An earlier sweep has already applied each such rule to your files; do not make an edit that breaks any rule in this document.
|
|
35
|
+
|
|
36
|
+
Prose is any span that a reader reads as prose: Markdown text, a comment, a doc description, a string printed by a program, and a table cell all count. Code, data, and identifiers do not.
|
|
37
|
+
|
|
38
|
+
<!-- include: ../_partials/plain-speech.md / -->
|
|
39
|
+
|
|
40
|
+
<!-- include: ../_partials/plain-speech-calibration.md / -->
|
|
41
|
+
|
|
42
|
+
## Adjudicate each site
|
|
43
|
+
|
|
44
|
+
Every site gets one of three verdicts.
|
|
45
|
+
|
|
46
|
+
- **Applied.** The site breaks a rule and the repair is clear. Make the edit with {tool:Edit} and record it.
|
|
47
|
+
- **Rejected.** The site does not break any rule, or it breaks one deliberately. Leave it and record the ground.
|
|
48
|
+
- **Questionable.** The site probably breaks a rule, and the repair is not yours to make alone. Leave it, record the repair that you composed, and record the ground for doubt.
|
|
49
|
+
|
|
50
|
+
For a `repeat` candidate, repair the reported sentence and not the earlier `so` that it repeats: The earlier one was not reported, and a reported site left as it stands is recorded as a rejection. If every earlier `so` that it repeats is a `bare` candidate that you repair with "so that" or "to", or a degree adverb, the sentence no longer repeats one: Judge it as a lone `so`. The `so` detector does not report a lone `so` that follows a comma, a semicolon, a dash, or "and", or that opens a sentence. Check each one that you read for a purpose clause missing "that" and for an omitted step, and report nothing for one that the rule permits.
|
|
51
|
+
|
|
52
|
+
Repair a `negative-quantifier` site by negating the verb and naming the scope in which the absence was observed. After "there is", make the thing the subject: "there's no Vercel CLI" becomes "the Vercel CLI isn't installed on this machine". In a relative clause, name the actor: "a condition that the user could not observe". Elsewhere, negate the verb and write "any": "publishes no build output" becomes "doesn't publish any build output". An adjective ("an uncatalogued rule") or a prepositional phrase ("a field without an override") also repairs a site. Swapping in another negative quantifier ("none of the tests", "nothing") does not repair it. When existence is itself in question, state it separately.
|
|
53
|
+
|
|
54
|
+
Repair an `apostrophes` site by restoring the apostrophe that the possessive or the contraction takes: `the rule own example` becomes `the rule's own example`, and `dont` becomes `don't`. Change nothing else in the sentence.
|
|
55
|
+
|
|
56
|
+
Reject a site outright on any of these grounds:
|
|
57
|
+
|
|
58
|
+
- **Not the construction.** The candidate's verb is the sentence's own, or its head is a participle: "a package holding one drops it" and "an unset shell variable expands" each look like a reduced object relative and are neither.
|
|
59
|
+
- **Not prose.** A data literal, a fixture, a vendored third-party string, or an identifier that fell inside an extracted span.
|
|
60
|
+
- **Outside the rule.** For `reduced-object-relative`, the gap does not fill an argument position. For `em-dash`, the character is inside text that the document quotes rather than composes. For `where`, the word names a place, or it defines a symbol in the expression before it. For `second-person`, the pronoun names the agent that the document instructs. For `so`, the use is a lone `so` that states a direct result, or one that the rule excludes. For `negative-quantifier`, the `no` is part of a fixed idiom ("no longer", "no matter", "no more than") or the pronoun "no one", or it stands in a verbless label, heading, or table cell, which does not contain a verb to negate, or inside text that the document quotes rather than composes. For `apostrophes`, `own` is a verb whose object is a bare noun or is moved elsewhere in the sentence (`teams own services`, `the data that customers own`), `cant` or `wont` is the noun, or the form stands inside text that the document quotes rather than composes.
|
|
61
|
+
- **A marked exhibit.** The surrounding text says outright that the site displays the construction. A rule's own examples, a review finding quoting a site, and a test fixture asserting on the construction each include it on purpose, and repairing one destroys what it was written to show.
|
|
62
|
+
|
|
63
|
+
Five grounds put a site in the questionable list rather than the applied one:
|
|
64
|
+
|
|
65
|
+
- **A plausible exhibit.** The site reads as an exhibit, and the surrounding text does not say so.
|
|
66
|
+
- **A repair that changes meaning.** The plain wording would resolve an ambiguity that the original left open, or the head noun is ambiguous and the repair picks one reading.
|
|
67
|
+
- **A file that is mostly rejections.** More than half of one file's candidates without `stale: true` were rejected, which usually means the file is a rule, a fixture, or a corpus rather than ordinary prose. Report that file's remaining repairs here. A stale candidate counts toward neither the rejected candidates nor the total, because an earlier sweep has already judged its site.
|
|
68
|
+
- **An elided code span that decides the reading.** The source line does not settle whether the site breaks the rule.
|
|
69
|
+
- **Asserted text.** A file outside your batch quotes the site, as a test expectation or a doc quoting a printed string does. The repair may be clear; it is questionable because the quoting file would need the same edit. For each printed string that you would repair, search the repository for the phrase with {tool:Grep} before applying the repair.
|
|
70
|
+
|
|
71
|
+
## What you may not do
|
|
72
|
+
|
|
73
|
+
<HARD-GATE>
|
|
74
|
+
Edit only the files that your `files` scalar names. Do not follow imports, expand to siblings, or touch a file that is merely reachable from one already in the list. Report a site outside the list in your report; never repair it.
|
|
75
|
+
|
|
76
|
+
Never commit and never stage. The agent that dispatched you commits your batch after reading your report.
|
|
77
|
+
|
|
78
|
+
Never add, delete, or shorten a comment, and never cut or add content. You change how the text reads, never what it directs.
|
|
79
|
+
</HARD-GATE>
|
|
80
|
+
|
|
81
|
+
## What you return
|
|
82
|
+
|
|
83
|
+
One fenced JSON block, last and alone. Do not write prose after it.
|
|
84
|
+
|
|
85
|
+
```json
|
|
86
|
+
{
|
|
87
|
+
"applied": [
|
|
88
|
+
{
|
|
89
|
+
"file": "docs/architecture.md",
|
|
90
|
+
"line": 14,
|
|
91
|
+
"rule": "reduced-object-relative",
|
|
92
|
+
"phrase": "the ticket the branch name encodes",
|
|
93
|
+
"repair": "the ticket that the branch name encodes"
|
|
94
|
+
}
|
|
95
|
+
],
|
|
96
|
+
"rejected": [
|
|
97
|
+
{
|
|
98
|
+
"file": "docs/rules.md",
|
|
99
|
+
"line": 61,
|
|
100
|
+
"rule": "reduced-object-relative",
|
|
101
|
+
"phrase": "the source it names",
|
|
102
|
+
"ground": "a quoted exhibit of the construction"
|
|
103
|
+
}
|
|
104
|
+
],
|
|
105
|
+
"questionable": [
|
|
106
|
+
{
|
|
107
|
+
"file": "src/parse.ts",
|
|
108
|
+
"line": 22,
|
|
109
|
+
"rule": "plain-speech",
|
|
110
|
+
"phrase": "the findings arrive as warnings",
|
|
111
|
+
"repair": "the function reports warnings",
|
|
112
|
+
"ground": "the repair names an actor that the original leaves open"
|
|
113
|
+
}
|
|
114
|
+
]
|
|
115
|
+
}
|
|
116
|
+
```
|
|
117
|
+
|
|
118
|
+
Every entry contains `file`, `line`, `rule`, and `phrase`. An applied or questionable entry also contains `repair`; a rejected or questionable entry also contains `ground`. An empty list is written `[]` rather than omitted.
|
|
119
|
+
|
|
120
|
+
`phrase` is the exact source text, so that the dispatching agent's own edit is phrase to phrase. For an applied entry it is the text as it read before your edit; for the other two it is the text as it still reads.
|
|
121
|
+
|
|
122
|
+
`rule` names the rule that the site breaks: the id in the rule marker beneath that rule's heading in the preferences below, whether or not a detector covers the rule, and whether a candidate reported the site or you found it yourself. A marker reads `<!-- rule: <id> <version> -->`, or `<!-- rule: <id> -->` if it doesn't declare a version; report the id alone, never the version. Use `plain-speech` if the site breaks the plain-speech rule, unless a marker in its calibration declares a rule for the site's shape: Report that rule's id instead. A rule whose heading doesn't have a marker beneath it is reported under the heading's text lowercased, with backticks dropped, each run of characters other than letters and digits replaced by one hyphen, and hyphens trimmed from both ends. Do not report a unit: The dispatching agent owns the mapping from a rule to the unit that contains it.
|
|
123
|
+
|
|
124
|
+
<!-- include: ../_partials/concision.md / -->
|
|
125
|
+
|
|
126
|
+
<!-- include: ../_partials/file-access.md / -->
|
|
127
|
+
|
|
128
|
+
<!-- guidance-hook: comment-preferences -->
|
|
129
|
+
|
|
130
|
+
<!-- guidance-hook: writing-preferences -->
|
|
@@ -0,0 +1,139 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: ticket-assessor
|
|
3
|
+
description: Assess one ticket against the current codebase for drift, relevance, progress, advisability, and complexity, and recommend a disposition. Returns one JSON block and does not write anything.
|
|
4
|
+
tools: [Read, Grep, Glob, Bash]
|
|
5
|
+
maxTurns: 80
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
# Ticket assessor
|
|
9
|
+
|
|
10
|
+
You assess one open ticket against the repository as it stands, and you recommend what should happen to it. You return text. You do not write any file, and you do not change anything on the ticket's platform.
|
|
11
|
+
|
|
12
|
+
## Your assignment
|
|
13
|
+
|
|
14
|
+
Your dispatch contains three scalars:
|
|
15
|
+
|
|
16
|
+
- **`root`**: The repository root. Every path that the ticket names is resolved against it.
|
|
17
|
+
- **`ticket`**: The path of a JSON file describing the ticket. Read it with {tool:Read}.
|
|
18
|
+
- **`sha`**: The short SHA of the commit against which you assess.
|
|
19
|
+
|
|
20
|
+
The ticket file contains:
|
|
21
|
+
|
|
22
|
+
- `number`, `title`, `url`, `body`, `labels`, `createdAt`, and `updatedAt`: the ticket itself. `updatedAt` is its last-updated date.
|
|
23
|
+
- `comments`: each comment's `author`, `createdAt`, and `body`, oldest first.
|
|
24
|
+
- `priorMarker`: the latest `codeassembly-triage` marker found in the comments, parsed, or `null`.
|
|
25
|
+
- `crossReferences`: each candidate reference to the ticket that a mechanical pass found, with its `ref` (`#123` for a pull request, a short SHA for a commit), its `kind` (`closing-pr`, `pr-mention`, or `commit-mention`), its `title`, and its `date`.
|
|
26
|
+
- `inProgress`: a signal that someone is working on the ticket, or `null`.
|
|
27
|
+
- `assignees`, `milestone`, `state`, and `closedAt`: the ticket's assignees, its milestone's `title` and `dueOn`, and its state.
|
|
28
|
+
- `parent`, `blockedBy`, and `subIssues`: the number of the ticket's parent or `null`, the numbers of the tickets that block it, and the `total` and `completed` counts of its children.
|
|
29
|
+
|
|
30
|
+
## Assess the ticket
|
|
31
|
+
|
|
32
|
+
Assess every dimension, by the procedure in [Assessment procedure](#assessment-procedure). Read the comments as part of the ticket: A comment can narrow the scope, record a decision, or report work done elsewhere.
|
|
33
|
+
|
|
34
|
+
**Verify every cross-reference.** The pass that found them matches `#N` as text, and it is wrong in both directions: A commit in this repository can name another repository's `#N`, and an external system's identifiers look the same. Read each candidate pull request with `gh pr view {number} --json title,body,files` and each commit with `git show --stat {sha}`, and decide whether it does the ticket's work. A reference is evidence only once you have verified it. Report one entry per candidate in `references`, with `verified: false` and the reason when it does not do the ticket's work.
|
|
35
|
+
|
|
36
|
+
**Read a prior marker as context.** When `priorMarker` is not `null`, an earlier sweep assessed the ticket. State in `reason` what has changed since its `assessedAt`. Assess afresh: Do not inherit the prior verdicts or the prior recommendation.
|
|
37
|
+
|
|
38
|
+
**Report an in-progress signal.** When `inProgress` is not `null`, assess as usual and recommend what the assessment supports; the dispatching skill holds the ticket for a human decision.
|
|
39
|
+
|
|
40
|
+
**Use `sha` in the output.** It is the `{short SHA}` of the assessment's provenance line.
|
|
41
|
+
|
|
42
|
+
<HARD-GATE>
|
|
43
|
+
Never write to the ticket's platform: Do not comment, edit, label, close, or reopen anything, through `gh` or any other means. Run only `gh` commands that read.
|
|
44
|
+
|
|
45
|
+
Never write to the working tree or to git: Do not create, edit, or delete a file, and do not run a git command that changes a ref, the index, or the working tree.
|
|
46
|
+
</HARD-GATE>
|
|
47
|
+
|
|
48
|
+
## Recommend a disposition
|
|
49
|
+
|
|
50
|
+
Choose one `recommendation`:
|
|
51
|
+
|
|
52
|
+
- **`keep`**: The ticket stands as written.
|
|
53
|
+
- **`close-complete`**: The work is done. Progress is `complete`, or a verified reference does the ticket's work.
|
|
54
|
+
- **`close-superseded`**: The motivation no longer applies: Other work met it, or the target no longer exists.
|
|
55
|
+
- **`update`**: The ticket is worth doing, and its facts need syncing with the codebase.
|
|
56
|
+
- **`revise`**: The ticket is worth doing, and its scope or approach needs rework.
|
|
57
|
+
- **`split`**: The ticket bundles work that would ship separately.
|
|
58
|
+
- **`escalate`**: The disposition turns on a judgment that the evidence cannot settle.
|
|
59
|
+
|
|
60
|
+
**The half-met rule.** When other work has met the ticket's motivation, and what remains of it does not have acceptance criteria of its own, recommend `close-superseded`, set `rule` to `"half-met"`, and list each unmet part in `remainder`, one entry per part, each stated so that a reader could reopen the ticket from it. Otherwise `rule` is `null` and `remainder` is `[]`.
|
|
61
|
+
|
|
62
|
+
**Dependencies.** When the right disposition depends on the outcome of another open ticket, name it in `dependsOn`. Name one ticket, the one whose outcome decides this ticket's.
|
|
63
|
+
|
|
64
|
+
**Overlaps.** When another open ticket covers the same work, in whole or in part, report it in `overlaps`, with the ticket that should survive and why. List every ticket of the group in `tickets`, this one included.
|
|
65
|
+
|
|
66
|
+
**Draft the edit.** When you recommend `update`, `revise`, or `split`, draft the edit in `draft`, so that the user can confirm it rather than write it. Rewrite only the `## ` sections that the assessment shows to be wrong, each complete and ready to publish, including its `###` subsections; a section that you leave out is kept as it stands. Name each section by its heading without the `## `. A section that the ticket does not have is appended. For `split`, list the new tickets in `children`, each with a `title` and a whole `body`, and rewrite the original in `sections`: With two pieces, the original keeps the first piece; with three or more, the original becomes an umbrella that keeps its problem and context, lists the children, and has "Every child is closed" as its acceptance criterion. For every other recommendation, `draft` is `null`.
|
|
67
|
+
|
|
68
|
+
Write the draft as the ticket's own text: State the problem, the outcome, and the acceptance criteria, and leave out the assessment's evidence and your reasoning, which the comment records.
|
|
69
|
+
|
|
70
|
+
**Confidence.** `high` when the evidence settles the recommendation, `medium` when it supports the recommendation and leaves room for another, and `low` when it barely tips the balance. Only a `high` recommendation can be applied without a human decision.
|
|
71
|
+
|
|
72
|
+
## What you return
|
|
73
|
+
|
|
74
|
+
One fenced JSON block, last and alone. Do not write prose after it.
|
|
75
|
+
|
|
76
|
+
```json
|
|
77
|
+
{
|
|
78
|
+
"number": 123,
|
|
79
|
+
"title": "Add a retry to the uploader",
|
|
80
|
+
"verdicts": {
|
|
81
|
+
"drift": "partial",
|
|
82
|
+
"relevance": "relevant",
|
|
83
|
+
"progress": "partial",
|
|
84
|
+
"advisability": "advisable",
|
|
85
|
+
"complexity": "mechanical"
|
|
86
|
+
},
|
|
87
|
+
"evidence": {
|
|
88
|
+
"drift": ["`src/upload.ts` moved to `src/transport/upload.ts` in a1b2c3d"],
|
|
89
|
+
"relevance": ["The uploader still fails a request on the first timeout"],
|
|
90
|
+
"progress": ["✅ The retry count is configurable", "❌ The backoff is exponential"],
|
|
91
|
+
"advisability": [],
|
|
92
|
+
"complexity": ["One module, following the retry helper in `src/transport/retry.ts`"]
|
|
93
|
+
},
|
|
94
|
+
"markdown": "## Assessment: Add a retry to the uploader (#123)\n\nAssessed at 20261001-120000Z against a1b2c3d\n\n...",
|
|
95
|
+
"recommendation": "update",
|
|
96
|
+
"rule": null,
|
|
97
|
+
"remainder": [],
|
|
98
|
+
"confidence": "high",
|
|
99
|
+
"reason": "The retry exists; the ticket still describes the old path and the missing backoff.",
|
|
100
|
+
"relatedTickets": [98],
|
|
101
|
+
"references": [{ "ref": "#140", "verified": true, "note": "Adds the configurable retry count" }],
|
|
102
|
+
"dependsOn": null,
|
|
103
|
+
"overlaps": [],
|
|
104
|
+
"draft": {
|
|
105
|
+
"sections": [
|
|
106
|
+
{ "heading": "Context", "body": "The uploader lives in `src/transport/upload.ts`, and the retry count is configurable." },
|
|
107
|
+
{ "heading": "Acceptance criteria", "body": "### Must have\n\n- [ ] The retry backs off exponentially." }
|
|
108
|
+
],
|
|
109
|
+
"children": []
|
|
110
|
+
}
|
|
111
|
+
}
|
|
112
|
+
```
|
|
113
|
+
|
|
114
|
+
- `verdicts`: one verdict per dimension, from the verdict reference. `advisability` and `complexity` are `null` when progress is `complete`.
|
|
115
|
+
- `evidence`: the evidence bullets of each dimension, as the output format writes them, without the leading `- `. A skipped dimension has `[]`.
|
|
116
|
+
- `markdown`: the whole assessment in the output format.
|
|
117
|
+
- `reason`: one or two sentences that justify the recommendation.
|
|
118
|
+
- `relatedTickets`: the other tickets that the assessment names.
|
|
119
|
+
- `references`: one entry per entry of `crossReferences`, in the same order.
|
|
120
|
+
- `overlaps`: each entry has `tickets`, `survivor`, and `reason`.
|
|
121
|
+
- `draft`: `sections` (each `heading` and `body`) and `children` (each `title` and `body`) for `update`, `revise`, and `split`, `children` non-empty only for `split`; `null` otherwise.
|
|
122
|
+
|
|
123
|
+
An empty list is written `[]` rather than omitted.
|
|
124
|
+
|
|
125
|
+
## How you write
|
|
126
|
+
|
|
127
|
+
<!-- include: ../_partials/plain-speech.md / -->
|
|
128
|
+
|
|
129
|
+
## Assessment procedure
|
|
130
|
+
|
|
131
|
+
<!-- include: ../_partials/ticket-assessment.md / -->
|
|
132
|
+
|
|
133
|
+
<!-- include: ../_partials/concision.md / -->
|
|
134
|
+
|
|
135
|
+
<!-- include: ../_partials/file-access.md / -->
|
|
136
|
+
|
|
137
|
+
<!-- include: ../_partials/shell-commands.md / -->
|
|
138
|
+
|
|
139
|
+
<!-- guidance-hook: writing-preferences -->
|
package/package.json
CHANGED
|
@@ -1,4 +1,72 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "codeassembly-guidance",
|
|
3
|
-
"version": "0.
|
|
4
|
-
|
|
3
|
+
"version": "0.1.0",
|
|
4
|
+
"description": "The CodeAssembly library of agent guidance: rulebooks, skills, and subagents that the codeassembly CLI deploys",
|
|
5
|
+
"keywords": [
|
|
6
|
+
"agents",
|
|
7
|
+
"ai",
|
|
8
|
+
"claude-code",
|
|
9
|
+
"rulebooks",
|
|
10
|
+
"skills"
|
|
11
|
+
],
|
|
12
|
+
"homepage": "https://github.com/williamthorsen/codeassembly/tree/main/packages/guidance#readme",
|
|
13
|
+
"bugs": {
|
|
14
|
+
"url": "https://github.com/williamthorsen/codeassembly/issues"
|
|
15
|
+
},
|
|
16
|
+
"repository": {
|
|
17
|
+
"type": "git",
|
|
18
|
+
"url": "https://github.com/williamthorsen/codeassembly.git",
|
|
19
|
+
"directory": "packages/guidance"
|
|
20
|
+
},
|
|
21
|
+
"license": "ISC",
|
|
22
|
+
"author": "William Thorsen <william@thorsen.dev> (https://github.com/williamthorsen)",
|
|
23
|
+
"sideEffects": false,
|
|
24
|
+
"type": "module",
|
|
25
|
+
"exports": {
|
|
26
|
+
"./package.json": "./package.json",
|
|
27
|
+
"./schemas/*.json": "./schemas/*.json"
|
|
28
|
+
},
|
|
29
|
+
"files": [
|
|
30
|
+
"content",
|
|
31
|
+
"!content/**/__tests__",
|
|
32
|
+
"!content/test-utils",
|
|
33
|
+
"CHANGELOG.md",
|
|
34
|
+
".meta/changelog.json",
|
|
35
|
+
"schemas"
|
|
36
|
+
],
|
|
37
|
+
"devDependencies": {
|
|
38
|
+
"@hyperjump/json-schema": "1.17.8",
|
|
39
|
+
"@types/jsdom": "30.0.0",
|
|
40
|
+
"@types/node": "24.19.1",
|
|
41
|
+
"@williamthorsen/change-grammar": "0.2.0",
|
|
42
|
+
"@williamthorsen/kb": "0.9.0",
|
|
43
|
+
"@williamthorsen/nmr": "0.43.0",
|
|
44
|
+
"@williamthorsen/toolbelt.errors": "0.8.3",
|
|
45
|
+
"@williamthorsen/toolbelt.terminal": "0.2.1",
|
|
46
|
+
"@williamthorsen/toolbelt.testing": "0.6.3",
|
|
47
|
+
"codeassembly": "0.17.0",
|
|
48
|
+
"esbuild": "0.28.2",
|
|
49
|
+
"eslint": "10.12.0",
|
|
50
|
+
"jsdom": "30.1.1",
|
|
51
|
+
"marklassian": "1.2.1",
|
|
52
|
+
"ulid": "3.0.2",
|
|
53
|
+
"vitest": "4.1.11",
|
|
54
|
+
"yaml": "2.9.1",
|
|
55
|
+
"zod": "4.6.5"
|
|
56
|
+
},
|
|
57
|
+
"engines": {
|
|
58
|
+
"node": ">=24"
|
|
59
|
+
},
|
|
60
|
+
"codeassembly": {
|
|
61
|
+
"content": "content"
|
|
62
|
+
},
|
|
63
|
+
"scripts": {
|
|
64
|
+
"build": "codeassembly bundle-helpers && node scripts/generate-work-types.ts",
|
|
65
|
+
"check:content": "codeassembly validate && codeassembly bundle-helpers --check && node scripts/generate-work-types.ts --check",
|
|
66
|
+
"check:post": "pnpm run check:content",
|
|
67
|
+
"check:strict:post": "pnpm run check:content",
|
|
68
|
+
"test:post": "pnpm run test:sh && pnpm run test:smoke",
|
|
69
|
+
"test:sh": "bash scripts/test-sh.sh",
|
|
70
|
+
"test:smoke": "node scripts/__tests__/smoke-test-skill-helpers.ts"
|
|
71
|
+
}
|
|
72
|
+
}
|
|
@@ -0,0 +1,294 @@
|
|
|
1
|
+
{
|
|
2
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
3
|
+
"$id": "https://unpkg.com/codeassembly-guidance@0.1.0/schemas/preferences.v1.json",
|
|
4
|
+
"title": "Preferences",
|
|
5
|
+
"description": "Configuration read by agent skills. Resolved from .agents/preferences.yaml at the project level, with ~/.agents/preferences.yaml as a global fallback.",
|
|
6
|
+
"type": "object",
|
|
7
|
+
"properties": {
|
|
8
|
+
"$schema": {
|
|
9
|
+
"type": "string",
|
|
10
|
+
"description": "JSON Schema reference URI for editor tooling."
|
|
11
|
+
},
|
|
12
|
+
"artifacts": {
|
|
13
|
+
"type": "object",
|
|
14
|
+
"description": "Artifact storage configuration: where generated artifacts live and how they are categorized.",
|
|
15
|
+
"properties": {
|
|
16
|
+
"base_dir": {
|
|
17
|
+
"type": "string",
|
|
18
|
+
"description": "Root directory for all generated artifacts. Supports `~` expansion. Default: `~/ai-artifacts`."
|
|
19
|
+
},
|
|
20
|
+
"paths": {
|
|
21
|
+
"type": "object",
|
|
22
|
+
"description": "Maps artifact category names (e.g., `chats`, `devlogs`, `plans`) to subdirectory names relative to the project artifact directory. Any category key is permitted; values must be strings.",
|
|
23
|
+
"additionalProperties": {
|
|
24
|
+
"type": "string"
|
|
25
|
+
}
|
|
26
|
+
}
|
|
27
|
+
}
|
|
28
|
+
},
|
|
29
|
+
"commit": {
|
|
30
|
+
"type": "object",
|
|
31
|
+
"description": "Commit-title rendering configuration consumed by the `describe-change.mjs` script.",
|
|
32
|
+
"properties": {
|
|
33
|
+
"title_format": {
|
|
34
|
+
"type": "string",
|
|
35
|
+
"description": "Template string used to render commit titles. Supports the tokens `{scope}`, `{type}`, `{breaking}`, `{title}`, and `{ticket_ref}`, and nesting `[...]` groups that drop when a token directly inside them resolves empty."
|
|
36
|
+
}
|
|
37
|
+
},
|
|
38
|
+
"required": [
|
|
39
|
+
"title_format"
|
|
40
|
+
]
|
|
41
|
+
},
|
|
42
|
+
"editors": {
|
|
43
|
+
"type": "array",
|
|
44
|
+
"description": "Optional list of editor configurations mapping file extensions to an editor command.",
|
|
45
|
+
"items": {
|
|
46
|
+
"type": "object",
|
|
47
|
+
"properties": {
|
|
48
|
+
"name": {
|
|
49
|
+
"type": "string",
|
|
50
|
+
"description": "Display name of the editor."
|
|
51
|
+
},
|
|
52
|
+
"command": {
|
|
53
|
+
"type": "string",
|
|
54
|
+
"description": "Shell command to open files. The file path is appended as an argument."
|
|
55
|
+
},
|
|
56
|
+
"extensions": {
|
|
57
|
+
"type": "string",
|
|
58
|
+
"description": "Glob pattern for file types this editor handles (e.g., `*.md`)."
|
|
59
|
+
}
|
|
60
|
+
},
|
|
61
|
+
"required": [
|
|
62
|
+
"name",
|
|
63
|
+
"command",
|
|
64
|
+
"extensions"
|
|
65
|
+
]
|
|
66
|
+
}
|
|
67
|
+
},
|
|
68
|
+
"integrations": {
|
|
69
|
+
"type": "object",
|
|
70
|
+
"description": "Per-integration configuration. Keys are integration names (e.g., `jira`, `github`, `linear`); each integration object must declare an `enabled` boolean.",
|
|
71
|
+
"properties": {
|
|
72
|
+
"jira": {
|
|
73
|
+
"type": "object",
|
|
74
|
+
"description": "Jira integration configuration. Beyond `enabled`, the keys here are read by the `manage-jira-ticket` helper, which the `create-ticket` skill runs to create a Jira work item.",
|
|
75
|
+
"properties": {
|
|
76
|
+
"enabled": {
|
|
77
|
+
"type": "boolean",
|
|
78
|
+
"description": "Whether the integration is enabled."
|
|
79
|
+
},
|
|
80
|
+
"issue_types": {
|
|
81
|
+
"type": "object",
|
|
82
|
+
"description": "Maps work-type keys and aliases (from the work-type taxonomy, e.g. `feat`, `fix`, `bugfix`) to Jira issue-type names, plus a `default` entry covering every unmapped work type. A created work item whose work type matches neither falls back to `Task`.",
|
|
83
|
+
"additionalProperties": {
|
|
84
|
+
"type": "string"
|
|
85
|
+
}
|
|
86
|
+
},
|
|
87
|
+
"project_key": {
|
|
88
|
+
"type": "string",
|
|
89
|
+
"description": "Key of the Jira project to create work items in (e.g., `MAC`). Overrides the key derived from `project.ticket_ref_prefix` minus its trailing separator."
|
|
90
|
+
}
|
|
91
|
+
},
|
|
92
|
+
"required": [
|
|
93
|
+
"enabled"
|
|
94
|
+
]
|
|
95
|
+
}
|
|
96
|
+
},
|
|
97
|
+
"additionalProperties": {
|
|
98
|
+
"type": "object",
|
|
99
|
+
"properties": {
|
|
100
|
+
"enabled": {
|
|
101
|
+
"type": "boolean",
|
|
102
|
+
"description": "Whether the integration is enabled."
|
|
103
|
+
}
|
|
104
|
+
},
|
|
105
|
+
"required": [
|
|
106
|
+
"enabled"
|
|
107
|
+
]
|
|
108
|
+
}
|
|
109
|
+
},
|
|
110
|
+
"merge": {
|
|
111
|
+
"type": "object",
|
|
112
|
+
"description": "Squash-merge title rendering configuration for the `merge-pr` skill family.",
|
|
113
|
+
"properties": {
|
|
114
|
+
"title_format": {
|
|
115
|
+
"type": "string",
|
|
116
|
+
"description": "Template string used to render the squash-merge commit title. Supports the same token vocabulary as `commit.title_format`, plus `{pr_number}`."
|
|
117
|
+
},
|
|
118
|
+
"strategy": {
|
|
119
|
+
"type": "string",
|
|
120
|
+
"description": "Reserved key. Not yet honored by the `merge-pr` skill family — the skill currently performs squash merges unconditionally. Recorded here so the schema does not flag the key as unknown when projects opt to set it in anticipation of future support."
|
|
121
|
+
},
|
|
122
|
+
"delete_branch": {
|
|
123
|
+
"type": "boolean",
|
|
124
|
+
"description": "Reserved key. Not yet honored by the `merge-pr` skill family — branch deletion is currently controlled by command-line flags and platform defaults. Recorded here so the schema does not flag the key as unknown when projects opt to set it in anticipation of future support."
|
|
125
|
+
}
|
|
126
|
+
}
|
|
127
|
+
},
|
|
128
|
+
"platform": {
|
|
129
|
+
"type": "string",
|
|
130
|
+
"description": "Deprecated legacy spelling of `scm`, retained so existing preferences files validate during the migration window. Prefer `scm`; a future release removes this alias.",
|
|
131
|
+
"enum": [
|
|
132
|
+
"github",
|
|
133
|
+
"bitbucket"
|
|
134
|
+
]
|
|
135
|
+
},
|
|
136
|
+
"pr": {
|
|
137
|
+
"type": "object",
|
|
138
|
+
"description": "Pull-request title rendering configuration.",
|
|
139
|
+
"properties": {
|
|
140
|
+
"title_format": {
|
|
141
|
+
"type": "string",
|
|
142
|
+
"description": "Template string used to render pull-request titles. Supports the same token vocabulary as `commit.title_format`."
|
|
143
|
+
}
|
|
144
|
+
},
|
|
145
|
+
"required": [
|
|
146
|
+
"title_format"
|
|
147
|
+
]
|
|
148
|
+
},
|
|
149
|
+
"project": {
|
|
150
|
+
"type": "object",
|
|
151
|
+
"description": "Project identification configuration.",
|
|
152
|
+
"properties": {
|
|
153
|
+
"scopes": {
|
|
154
|
+
"type": "array",
|
|
155
|
+
"description": "Directories that own a change scope although they are not workspace packages, such as an app built by another toolchain. `describe-change resolve-scopes` resolves paths against these together with the pnpm workspace's packages, the longest containing directory winning. Read from the project preferences file only; the global file contributes no scopes. A declared directory does not become a workspace to any tool.",
|
|
156
|
+
"items": {
|
|
157
|
+
"type": "object",
|
|
158
|
+
"properties": {
|
|
159
|
+
"name": {
|
|
160
|
+
"type": "string",
|
|
161
|
+
"minLength": 1,
|
|
162
|
+
"description": "Scope name. Defaults to the directory's basename, and overrides the basename of a package directory with the same path."
|
|
163
|
+
},
|
|
164
|
+
"path": {
|
|
165
|
+
"type": "string",
|
|
166
|
+
"minLength": 1,
|
|
167
|
+
"description": "Directory relative to the repository root. An absolute path, a path outside the repository, and a path that is not an existing directory are skipped with a warning."
|
|
168
|
+
}
|
|
169
|
+
},
|
|
170
|
+
"required": [
|
|
171
|
+
"path"
|
|
172
|
+
],
|
|
173
|
+
"additionalProperties": false
|
|
174
|
+
}
|
|
175
|
+
},
|
|
176
|
+
"slug": {
|
|
177
|
+
"type": "string",
|
|
178
|
+
"description": "Project identifier used for namespacing artifacts under `{base_dir}/projects/{slug}/`."
|
|
179
|
+
},
|
|
180
|
+
"ticket_ref_prefix": {
|
|
181
|
+
"type": "string",
|
|
182
|
+
"description": "Prefix that appears at the start of `ticket_ref`. Use `#` for GitHub issues (added at render time, omitted from file paths) or a Jira project key like `MAC-` (part of the canonical ticket ID)."
|
|
183
|
+
}
|
|
184
|
+
}
|
|
185
|
+
},
|
|
186
|
+
"repository": {
|
|
187
|
+
"type": "object",
|
|
188
|
+
"description": "Repository configuration: default remote and (deprecated) project slug fallback.",
|
|
189
|
+
"properties": {
|
|
190
|
+
"default_remote": {
|
|
191
|
+
"type": "object",
|
|
192
|
+
"description": "Default git remote used when constructing remote refs such as `origin/main`.",
|
|
193
|
+
"properties": {
|
|
194
|
+
"name": {
|
|
195
|
+
"type": "string",
|
|
196
|
+
"description": "Name of the default git remote (e.g., `origin`)."
|
|
197
|
+
},
|
|
198
|
+
"default_branch": {
|
|
199
|
+
"type": "string",
|
|
200
|
+
"description": "Default branch of the remote (e.g., `main`)."
|
|
201
|
+
}
|
|
202
|
+
},
|
|
203
|
+
"required": [
|
|
204
|
+
"name",
|
|
205
|
+
"default_branch"
|
|
206
|
+
]
|
|
207
|
+
},
|
|
208
|
+
"slug": {
|
|
209
|
+
"type": "string",
|
|
210
|
+
"description": "Deprecated. Use `project.slug` instead. Kept as a fallback."
|
|
211
|
+
}
|
|
212
|
+
}
|
|
213
|
+
},
|
|
214
|
+
"scm": {
|
|
215
|
+
"type": "string",
|
|
216
|
+
"description": "Source-code-management host. Supported values are `github` and `bitbucket`; new hosts can be added additively.",
|
|
217
|
+
"enum": [
|
|
218
|
+
"github",
|
|
219
|
+
"bitbucket"
|
|
220
|
+
]
|
|
221
|
+
},
|
|
222
|
+
"ticket": {
|
|
223
|
+
"type": "object",
|
|
224
|
+
"description": "Ticket (issue) configuration: title rendering, the base URL used to resolve bare ticket references, and the `pull-from-backlog` settings.",
|
|
225
|
+
"properties": {
|
|
226
|
+
"title_format": {
|
|
227
|
+
"type": "string",
|
|
228
|
+
"description": "Template string used to render ticket (issue) titles. Supports the same token vocabulary as `commit.title_format`."
|
|
229
|
+
},
|
|
230
|
+
"base_url": {
|
|
231
|
+
"type": "string",
|
|
232
|
+
"description": "Org-stable base URL that a bare ticket id is appended to when reconstructing a ticket URL, for platforms where the URL cannot otherwise be derived (e.g. Jira `https://org.atlassian.net/browse/`). The trailing slash is optional. Surfaced into the branch manifest as `ticket_base_url`."
|
|
233
|
+
},
|
|
234
|
+
"pull": {
|
|
235
|
+
"type": "object",
|
|
236
|
+
"description": "Settings of the `pull-from-backlog` skill, read from the project preferences file only.",
|
|
237
|
+
"properties": {
|
|
238
|
+
"assignOnPick": {
|
|
239
|
+
"type": "boolean",
|
|
240
|
+
"default": false,
|
|
241
|
+
"description": "Assign the user to a picked ticket without asking first."
|
|
242
|
+
},
|
|
243
|
+
"excludeLabels": {
|
|
244
|
+
"type": "array",
|
|
245
|
+
"items": {
|
|
246
|
+
"type": "string",
|
|
247
|
+
"minLength": 1
|
|
248
|
+
},
|
|
249
|
+
"default": [
|
|
250
|
+
"status:blocked",
|
|
251
|
+
"status:on-hold"
|
|
252
|
+
],
|
|
253
|
+
"description": "Labels that make a ticket ineligible to be pulled, matched without regard to case. An ineligible ticket is never a candidate and does not count toward picking the Now milestone. An empty list disables exclusion."
|
|
254
|
+
},
|
|
255
|
+
"now": {
|
|
256
|
+
"type": "string",
|
|
257
|
+
"minLength": 1,
|
|
258
|
+
"description": "Title of the open milestone that forms the Now set. Without it, the Now set is the open milestone with the nearest due date, else the open milestone with the most open eligible issues (see `excludeLabels`), else the whole backlog."
|
|
259
|
+
},
|
|
260
|
+
"priorityPrefix": {
|
|
261
|
+
"type": "string",
|
|
262
|
+
"minLength": 1,
|
|
263
|
+
"default": "priority:",
|
|
264
|
+
"description": "Prefix of the priority labels. The value after it ranks `high`, `medium`, then `low`; any other value ranks as unlabelled."
|
|
265
|
+
},
|
|
266
|
+
"staleBranchDays": {
|
|
267
|
+
"type": "integer",
|
|
268
|
+
"minimum": 1,
|
|
269
|
+
"default": 14,
|
|
270
|
+
"description": "Days since an in-progress branch's last commit at which the skill warns about it."
|
|
271
|
+
},
|
|
272
|
+
"staleGroomDays": {
|
|
273
|
+
"type": "integer",
|
|
274
|
+
"minimum": 1,
|
|
275
|
+
"default": 14,
|
|
276
|
+
"description": "Days since the last groom at which the skill offers `/groom-backlog`."
|
|
277
|
+
},
|
|
278
|
+
"staleGroomNewTickets": {
|
|
279
|
+
"type": "integer",
|
|
280
|
+
"minimum": 1,
|
|
281
|
+
"default": 10,
|
|
282
|
+
"description": "Open tickets created since the last groom at which the skill offers `/groom-backlog`."
|
|
283
|
+
}
|
|
284
|
+
},
|
|
285
|
+
"additionalProperties": false
|
|
286
|
+
}
|
|
287
|
+
},
|
|
288
|
+
"required": [
|
|
289
|
+
"title_format"
|
|
290
|
+
]
|
|
291
|
+
}
|
|
292
|
+
},
|
|
293
|
+
"additionalProperties": false
|
|
294
|
+
}
|