codeassembly-guidance 0.0.0 → 0.2.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 +1320 -0
- package/CHANGELOG.md +315 -0
- package/LICENSE +7 -0
- package/README.md +195 -1
- package/bin/codeassembly-validate-preferences.js +18 -0
- 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 +70 -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 +6 -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 +59 -0
- package/content/collections/all.md +11 -0
- package/content/collections/atlassian.md +17 -0
- package/content/collections/recommended.md +41 -0
- package/content/collections/triage.md +13 -0
- package/content/collections/williamthorsen.md +26 -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 +38 -0
- package/content/guidance/rulebooks/cli-conventions.md +192 -0
- package/content/guidance/rulebooks/codeassembly-content-specification.md +184 -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 +19 -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 +273 -0
- package/content/guidance/rulebooks/ui-copy-conventions.md +34 -0
- package/content/guidance/rulebooks/williamthorsen-code-layout-preferences.md +102 -0
- package/content/guidance/rulebooks/williamthorsen-collaboration-preferences.md +60 -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 +51 -0
- package/content/scripts/README.md +44 -0
- package/content/scripts/check-branch-currency.mjs +11 -0
- package/content/scripts/check-prose.mjs +171 -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 +214 -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/scripts/validate-preferences.mjs +146 -0
- package/content/skills/_data/action-items.md +83 -0
- package/content/skills/_data/artifact-conventions.md +1001 -0
- package/content/skills/_data/bitbucket-pr-access.md +89 -0
- package/content/skills/_data/branch-currency.md +36 -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/project-stage.md +32 -0
- package/content/skills/_data/recommendation-gradient.md +92 -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 +180 -0
- package/content/skills/_data/title-templates.md +632 -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/jira-task-list-flattening.md +1 -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 +85 -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/assess-usability/SKILL.md +96 -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 +121 -0
- package/content/skills/create-pr/SKILL.md +150 -0
- package/content/skills/create-ticket/SKILL.md +395 -0
- package/content/skills/create-ticket/resolve-ticket-target.mjs +143 -0
- package/content/skills/derive-session-context/derive-session-context.mjs +149 -0
- package/content/skills/design-and-plan/SKILL.md +197 -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 +247 -0
- package/content/skills/groom-backlog/groom-backlog.mjs +108 -0
- package/content/skills/implement-plan/SKILL.md +168 -0
- package/content/skills/index-prototypes/SKILL.md +200 -0
- package/content/skills/index-prototypes/index-prototypes.mjs +388 -0
- package/content/skills/kb-add/SKILL.md +157 -0
- package/content/skills/kb-add/kb-add.mjs +216 -0
- package/content/skills/kb-curate/SKILL.md +119 -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 +207 -0
- package/content/skills/kb-retrieve-events/SKILL.md +98 -0
- package/content/skills/kb-retrieve-events/kb-retrieve-events.mjs +207 -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 +137 -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 +178 -0
- package/content/skills/pull-from-backlog/SKILL.md +83 -0
- package/content/skills/pull-from-backlog/pull-from-backlog.mjs +209 -0
- package/content/skills/refine-plan/SKILL.md +263 -0
- package/content/skills/refine-prototype/SKILL.md +113 -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 +303 -0
- package/content/skills/review-criteria/SKILL.md +141 -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 +148 -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 +71 -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 +317 -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 +235 -0
- package/content/skills/triage-spike-findings/SKILL.md +113 -0
- package/content/skills/triage-spike-findings/triage-spike-findings.mjs +71 -0
- package/content/skills/typescript-testing-conventions/SKILL.md +178 -0
- package/content/skills/update-jira-ticket/SKILL.md +257 -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 +25 -0
- package/content/subagents/_data/rovo.yaml +41 -0
- package/content/subagents/canary.md +12 -0
- package/content/subagents/disposition-challenger.md +78 -0
- package/content/subagents/entry-drafter.md +191 -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 +132 -0
- package/content/subagents/ticket-assessor.md +142 -0
- package/content/subagents/usability-assessor.md +157 -0
- package/package.json +74 -2
- package/schemas/preferences.v1.json +321 -0
- package/schemas/work-types.v1.json +142 -0
|
@@ -0,0 +1,321 @@
|
|
|
1
|
+
{
|
|
2
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
3
|
+
"$id": "https://unpkg.com/codeassembly-guidance@0.2.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, and the project's declared stage (`maturity`, `sensitivity`, `audience`), which design guidance treats as premises.",
|
|
152
|
+
"properties": {
|
|
153
|
+
"audience": {
|
|
154
|
+
"type": "string",
|
|
155
|
+
"enum": [
|
|
156
|
+
"owner",
|
|
157
|
+
"team",
|
|
158
|
+
"public"
|
|
159
|
+
],
|
|
160
|
+
"description": "Who uses the project. `owner`: only the repo's owner. `team`: a known, bounded group. `public`: anyone who can reach it. Read from the project preferences file only."
|
|
161
|
+
},
|
|
162
|
+
"maturity": {
|
|
163
|
+
"type": "string",
|
|
164
|
+
"enum": [
|
|
165
|
+
"hobby",
|
|
166
|
+
"early",
|
|
167
|
+
"production"
|
|
168
|
+
],
|
|
169
|
+
"description": "How far the project has come. `hobby`: built for the owner's own use or learning; breakage costs only the owner's time. `early`: in use by others, but the shape is still changing; downtime is tolerated. `production`: others depend on it; downtime and data loss have real costs. Read from the project preferences file only."
|
|
170
|
+
},
|
|
171
|
+
"scopes": {
|
|
172
|
+
"type": "array",
|
|
173
|
+
"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.",
|
|
174
|
+
"items": {
|
|
175
|
+
"type": "object",
|
|
176
|
+
"properties": {
|
|
177
|
+
"name": {
|
|
178
|
+
"type": "string",
|
|
179
|
+
"minLength": 1,
|
|
180
|
+
"description": "Scope name. Defaults to the directory's basename, and overrides the basename of a package directory with the same path."
|
|
181
|
+
},
|
|
182
|
+
"path": {
|
|
183
|
+
"type": "string",
|
|
184
|
+
"minLength": 1,
|
|
185
|
+
"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."
|
|
186
|
+
}
|
|
187
|
+
},
|
|
188
|
+
"required": [
|
|
189
|
+
"path"
|
|
190
|
+
],
|
|
191
|
+
"additionalProperties": false
|
|
192
|
+
}
|
|
193
|
+
},
|
|
194
|
+
"sensitivity": {
|
|
195
|
+
"type": "string",
|
|
196
|
+
"enum": [
|
|
197
|
+
"low",
|
|
198
|
+
"personal",
|
|
199
|
+
"confidential"
|
|
200
|
+
],
|
|
201
|
+
"description": "The most sensitive data that the project holds. `low`: nothing that would harm anyone if published. `personal`: personal data about the owner or identifiable individuals. `confidential`: secrets, credentials, or data that a third party is obliged to protect. Read from the project preferences file only."
|
|
202
|
+
},
|
|
203
|
+
"slug": {
|
|
204
|
+
"type": "string",
|
|
205
|
+
"description": "Project identifier used for namespacing artifacts under `{base_dir}/projects/{slug}/`."
|
|
206
|
+
},
|
|
207
|
+
"ticket_ref_prefix": {
|
|
208
|
+
"type": "string",
|
|
209
|
+
"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)."
|
|
210
|
+
}
|
|
211
|
+
}
|
|
212
|
+
},
|
|
213
|
+
"repository": {
|
|
214
|
+
"type": "object",
|
|
215
|
+
"description": "Repository configuration: default remote and (deprecated) project slug fallback.",
|
|
216
|
+
"properties": {
|
|
217
|
+
"default_remote": {
|
|
218
|
+
"type": "object",
|
|
219
|
+
"description": "Default git remote used when constructing remote refs such as `origin/main`.",
|
|
220
|
+
"properties": {
|
|
221
|
+
"name": {
|
|
222
|
+
"type": "string",
|
|
223
|
+
"description": "Name of the default git remote (e.g., `origin`)."
|
|
224
|
+
},
|
|
225
|
+
"default_branch": {
|
|
226
|
+
"type": "string",
|
|
227
|
+
"description": "Default branch of the remote (e.g., `main`)."
|
|
228
|
+
}
|
|
229
|
+
},
|
|
230
|
+
"required": [
|
|
231
|
+
"name",
|
|
232
|
+
"default_branch"
|
|
233
|
+
]
|
|
234
|
+
},
|
|
235
|
+
"slug": {
|
|
236
|
+
"type": "string",
|
|
237
|
+
"description": "Deprecated. Use `project.slug` instead. Kept as a fallback."
|
|
238
|
+
}
|
|
239
|
+
}
|
|
240
|
+
},
|
|
241
|
+
"scm": {
|
|
242
|
+
"type": "string",
|
|
243
|
+
"description": "Source-code-management host. Supported values are `github` and `bitbucket`; new hosts can be added additively.",
|
|
244
|
+
"enum": [
|
|
245
|
+
"github",
|
|
246
|
+
"bitbucket"
|
|
247
|
+
]
|
|
248
|
+
},
|
|
249
|
+
"ticket": {
|
|
250
|
+
"type": "object",
|
|
251
|
+
"description": "Ticket (issue) configuration: title rendering, the base URL used to resolve bare ticket references, and the `pull-from-backlog` settings.",
|
|
252
|
+
"properties": {
|
|
253
|
+
"title_format": {
|
|
254
|
+
"type": "string",
|
|
255
|
+
"description": "Template string used to render ticket (issue) titles. Supports the same token vocabulary as `commit.title_format`."
|
|
256
|
+
},
|
|
257
|
+
"base_url": {
|
|
258
|
+
"type": "string",
|
|
259
|
+
"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`."
|
|
260
|
+
},
|
|
261
|
+
"pull": {
|
|
262
|
+
"type": "object",
|
|
263
|
+
"description": "Settings of the `pull-from-backlog` skill, read from the project preferences file only.",
|
|
264
|
+
"properties": {
|
|
265
|
+
"assignOnPick": {
|
|
266
|
+
"type": "boolean",
|
|
267
|
+
"default": false,
|
|
268
|
+
"description": "Assign the user to a picked ticket without asking first."
|
|
269
|
+
},
|
|
270
|
+
"excludeLabels": {
|
|
271
|
+
"type": "array",
|
|
272
|
+
"items": {
|
|
273
|
+
"type": "string",
|
|
274
|
+
"minLength": 1
|
|
275
|
+
},
|
|
276
|
+
"default": [
|
|
277
|
+
"status:blocked",
|
|
278
|
+
"status:on-hold"
|
|
279
|
+
],
|
|
280
|
+
"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."
|
|
281
|
+
},
|
|
282
|
+
"now": {
|
|
283
|
+
"type": "string",
|
|
284
|
+
"minLength": 1,
|
|
285
|
+
"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."
|
|
286
|
+
},
|
|
287
|
+
"priorityPrefix": {
|
|
288
|
+
"type": "string",
|
|
289
|
+
"minLength": 1,
|
|
290
|
+
"default": "priority:",
|
|
291
|
+
"description": "Prefix of the priority labels. The value after it ranks `high`, `medium`, then `low`; any other value ranks as unlabelled."
|
|
292
|
+
},
|
|
293
|
+
"staleBranchDays": {
|
|
294
|
+
"type": "integer",
|
|
295
|
+
"minimum": 1,
|
|
296
|
+
"default": 14,
|
|
297
|
+
"description": "Days since an in-progress branch's last commit at which the skill warns about it."
|
|
298
|
+
},
|
|
299
|
+
"staleGroomDays": {
|
|
300
|
+
"type": "integer",
|
|
301
|
+
"minimum": 1,
|
|
302
|
+
"default": 14,
|
|
303
|
+
"description": "Days since the last groom at which the skill offers `/groom-backlog`."
|
|
304
|
+
},
|
|
305
|
+
"staleGroomNewTickets": {
|
|
306
|
+
"type": "integer",
|
|
307
|
+
"minimum": 1,
|
|
308
|
+
"default": 10,
|
|
309
|
+
"description": "Open tickets created since the last groom at which the skill offers `/groom-backlog`."
|
|
310
|
+
}
|
|
311
|
+
},
|
|
312
|
+
"additionalProperties": false
|
|
313
|
+
}
|
|
314
|
+
},
|
|
315
|
+
"required": [
|
|
316
|
+
"title_format"
|
|
317
|
+
]
|
|
318
|
+
}
|
|
319
|
+
},
|
|
320
|
+
"additionalProperties": false
|
|
321
|
+
}
|
|
@@ -0,0 +1,142 @@
|
|
|
1
|
+
{
|
|
2
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
3
|
+
"$id": "https://unpkg.com/codeassembly-guidance@0.2.0/schemas/work-types.v1.json",
|
|
4
|
+
"additionalProperties": false,
|
|
5
|
+
"description": "Canonical work-types taxonomy consumed by skill content and downstream changelog/release-notes tooling. Defines the work-type vocabulary, tier grouping, breaking-change policy, changelog-eligibility flags, and cross-cutting section markers (e.g., the breaking-changes indicator).",
|
|
6
|
+
"properties": {
|
|
7
|
+
"markers": {
|
|
8
|
+
"additionalProperties": false,
|
|
9
|
+
"description": "Cross-cutting section markers used in PR descriptions and release-notes rendering. Orthogonal to `types[]` — these are not work types but visual indicators applied inline to individual entries within their work-type subsection. Add new markers as sibling keys under `markers`; each follows the same `{emoji, label}` shape.",
|
|
10
|
+
"properties": {
|
|
11
|
+
"breaking": {
|
|
12
|
+
"additionalProperties": false,
|
|
13
|
+
"description": "Marker for breaking-change entries. Consumed by `summarize-change` as an inline prefix (`{emoji} **{label}:**`, e.g., `🚨 **Breaking:**`) on individual `## Details` entries that describe a breaking change; the entry stays under its work-type subsection.",
|
|
14
|
+
"properties": {
|
|
15
|
+
"emoji": {
|
|
16
|
+
"description": "Glyph rendered at the start of the inline breaking-change prefix.",
|
|
17
|
+
"minLength": 1,
|
|
18
|
+
"type": "string"
|
|
19
|
+
},
|
|
20
|
+
"label": {
|
|
21
|
+
"description": "Bare tag word rendered inside the inline prefix's bold construction (e.g., `**Breaking:**`). Singular — punctuation belongs to the rendering template.",
|
|
22
|
+
"minLength": 1,
|
|
23
|
+
"type": "string"
|
|
24
|
+
}
|
|
25
|
+
},
|
|
26
|
+
"required": [
|
|
27
|
+
"emoji",
|
|
28
|
+
"label"
|
|
29
|
+
],
|
|
30
|
+
"type": "object"
|
|
31
|
+
}
|
|
32
|
+
},
|
|
33
|
+
"required": [
|
|
34
|
+
"breaking"
|
|
35
|
+
],
|
|
36
|
+
"type": "object"
|
|
37
|
+
},
|
|
38
|
+
"tiers": {
|
|
39
|
+
"description": "Canonical tier vocabulary in precedence order (higher tier wins ties). Mirrored at `types[].tier`. Each position is pinned via `prefixItems` so that order is enforced structurally.",
|
|
40
|
+
"items": false,
|
|
41
|
+
"maxItems": 3,
|
|
42
|
+
"minItems": 3,
|
|
43
|
+
"prefixItems": [
|
|
44
|
+
{
|
|
45
|
+
"const": "public",
|
|
46
|
+
"type": "string"
|
|
47
|
+
},
|
|
48
|
+
{
|
|
49
|
+
"const": "internal",
|
|
50
|
+
"type": "string"
|
|
51
|
+
},
|
|
52
|
+
{
|
|
53
|
+
"const": "process",
|
|
54
|
+
"type": "string"
|
|
55
|
+
}
|
|
56
|
+
],
|
|
57
|
+
"type": "array"
|
|
58
|
+
},
|
|
59
|
+
"types": {
|
|
60
|
+
"description": "The work-type records, in canonical render order. Order is meaningful: when ranking applicable types within a tier, earlier entries win.",
|
|
61
|
+
"items": {
|
|
62
|
+
"additionalProperties": false,
|
|
63
|
+
"properties": {
|
|
64
|
+
"aliases": {
|
|
65
|
+
"description": "Alternative identifiers that resolve to the same `key`. Globally unique across all types (asserted in test).",
|
|
66
|
+
"items": {
|
|
67
|
+
"pattern": "^[a-z][a-z0-9-]*$",
|
|
68
|
+
"type": "string"
|
|
69
|
+
},
|
|
70
|
+
"type": "array",
|
|
71
|
+
"uniqueItems": true
|
|
72
|
+
},
|
|
73
|
+
"breakingPolicy": {
|
|
74
|
+
"description": "Whether a breaking-change marker (`!`) is forbidden or optional for this type.",
|
|
75
|
+
"enum": [
|
|
76
|
+
"forbidden",
|
|
77
|
+
"optional"
|
|
78
|
+
],
|
|
79
|
+
"type": "string"
|
|
80
|
+
},
|
|
81
|
+
"description": {
|
|
82
|
+
"description": "The changes that the type covers, read by an agent choosing a type for a change.",
|
|
83
|
+
"minLength": 1,
|
|
84
|
+
"type": "string"
|
|
85
|
+
},
|
|
86
|
+
"emoji": {
|
|
87
|
+
"description": "Single-character (or short) emoji used in section headers and changelog rendering.",
|
|
88
|
+
"minLength": 1,
|
|
89
|
+
"type": "string"
|
|
90
|
+
},
|
|
91
|
+
"excludedFromChangelog": {
|
|
92
|
+
"description": "When true, commits of this type are omitted from the generated changelog (e.g., `fmt`).",
|
|
93
|
+
"type": "boolean"
|
|
94
|
+
},
|
|
95
|
+
"key": {
|
|
96
|
+
"description": "Canonical short identifier used in commit messages (e.g., `feat`, `fix`).",
|
|
97
|
+
"pattern": "^[a-z][a-z0-9-]*$",
|
|
98
|
+
"type": "string"
|
|
99
|
+
},
|
|
100
|
+
"label": {
|
|
101
|
+
"description": "Human-readable category label used in section headings (e.g., `Features`, `Fixes`).",
|
|
102
|
+
"minLength": 1,
|
|
103
|
+
"type": "string"
|
|
104
|
+
},
|
|
105
|
+
"tier": {
|
|
106
|
+
"description": "Which tier this type belongs to. Drives precedence and grouping in skill content.",
|
|
107
|
+
"enum": [
|
|
108
|
+
"public",
|
|
109
|
+
"internal",
|
|
110
|
+
"process"
|
|
111
|
+
],
|
|
112
|
+
"type": "string"
|
|
113
|
+
}
|
|
114
|
+
},
|
|
115
|
+
"required": [
|
|
116
|
+
"aliases",
|
|
117
|
+
"breakingPolicy",
|
|
118
|
+
"description",
|
|
119
|
+
"emoji",
|
|
120
|
+
"key",
|
|
121
|
+
"label",
|
|
122
|
+
"tier"
|
|
123
|
+
],
|
|
124
|
+
"type": "object"
|
|
125
|
+
},
|
|
126
|
+
"type": "array"
|
|
127
|
+
},
|
|
128
|
+
"version": {
|
|
129
|
+
"description": "Semantic version of the data shape. Bump when the structure changes in a way that breaks downstream consumers.",
|
|
130
|
+
"pattern": "^\\d+\\.\\d+\\.\\d+$",
|
|
131
|
+
"type": "string"
|
|
132
|
+
}
|
|
133
|
+
},
|
|
134
|
+
"required": [
|
|
135
|
+
"markers",
|
|
136
|
+
"tiers",
|
|
137
|
+
"types",
|
|
138
|
+
"version"
|
|
139
|
+
],
|
|
140
|
+
"title": "Work types",
|
|
141
|
+
"type": "object"
|
|
142
|
+
}
|