@sienklogic/plan-build-run 2.56.2 → 2.56.3
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/CHANGELOG.md +613 -606
- package/package.json +1 -1
- package/plugins/codex-pbr/AGENTS.md +8 -8
- package/plugins/codex-pbr/agents/executor.md +5 -5
- package/plugins/codex-pbr/agents/general.md +1 -1
- package/plugins/codex-pbr/references/config-reference.md +1 -1
- package/plugins/codex-pbr/references/git-integration.md +36 -21
- package/plugins/codex-pbr/skills/undo/SKILL.md +7 -7
- package/plugins/copilot-pbr/agents/executor.agent.md +5 -5
- package/plugins/copilot-pbr/agents/general.agent.md +1 -1
- package/plugins/copilot-pbr/plugin.json +1 -1
- package/plugins/copilot-pbr/references/config-reference.md +1 -1
- package/plugins/copilot-pbr/references/git-integration.md +36 -21
- package/plugins/copilot-pbr/skills/begin/templates/config.json.tmpl +1 -1
- package/plugins/copilot-pbr/skills/undo/SKILL.md +7 -7
- package/plugins/cursor-pbr/.cursor-plugin/plugin.json +1 -1
- package/plugins/cursor-pbr/agents/executor.md +5 -5
- package/plugins/cursor-pbr/agents/general.md +1 -1
- package/plugins/cursor-pbr/references/config-reference.md +1 -1
- package/plugins/cursor-pbr/references/git-integration.md +36 -21
- package/plugins/cursor-pbr/skills/begin/templates/config.json.tmpl +1 -1
- package/plugins/cursor-pbr/skills/undo/SKILL.md +7 -7
- package/plugins/pbr/.claude-plugin/plugin.json +1 -1
- package/plugins/pbr/agents/executor.md +5 -5
- package/plugins/pbr/agents/general.md +1 -1
- package/plugins/pbr/references/archive/pbr-rules.md +1 -1
- package/plugins/pbr/references/config-reference.md +1 -1
- package/plugins/pbr/references/git-integration.md +36 -21
- package/plugins/pbr/skills/begin/templates/config.json.tmpl +1 -1
- package/plugins/pbr/skills/undo/SKILL.md +7 -7
|
@@ -64,9 +64,9 @@ Present grouped output:
|
|
|
64
64
|
```
|
|
65
65
|
Recent PBR commits (grouped by scope):
|
|
66
66
|
|
|
67
|
-
[
|
|
68
|
-
abc1234 feat(
|
|
69
|
-
def5678 chore(
|
|
67
|
+
[undo]
|
|
68
|
+
abc1234 feat(undo): add undo skill
|
|
69
|
+
def5678 chore(undo): register undo command
|
|
70
70
|
|
|
71
71
|
[quick-003]
|
|
72
72
|
ghi9012 fix(quick-003): fix hook path resolution
|
|
@@ -75,7 +75,7 @@ Recent PBR commits (grouped by scope):
|
|
|
75
75
|
jkl3456 docs(planning): update roadmap phase 55
|
|
76
76
|
```
|
|
77
77
|
|
|
78
|
-
For phase-plan scopes (NN-MM pattern), add a "Phase NN, Plan MM" annotation.
|
|
78
|
+
For descriptive scopes, show just the scope label. For phase-plan scopes (NN-MM pattern, from older commits), add a "Phase NN, Plan MM" annotation.
|
|
79
79
|
|
|
80
80
|
---
|
|
81
81
|
|
|
@@ -103,8 +103,8 @@ Display the commits that will be reverted:
|
|
|
103
103
|
```
|
|
104
104
|
The following commits will be reverted (using git revert, NOT git reset):
|
|
105
105
|
|
|
106
|
-
abc1234 feat(
|
|
107
|
-
def5678 chore(
|
|
106
|
+
abc1234 feat(undo): add undo skill
|
|
107
|
+
def5678 chore(undo): register undo command
|
|
108
108
|
|
|
109
109
|
This creates new revert commits — your history is preserved.
|
|
110
110
|
```
|
|
@@ -126,7 +126,7 @@ git revert --no-commit {hash}
|
|
|
126
126
|
```
|
|
127
127
|
|
|
128
128
|
After all reverts are staged, determine the commit message:
|
|
129
|
-
- Extract scope from the first commit being reverted (e.g., `
|
|
129
|
+
- Extract scope from the first commit being reverted (e.g., `undo`, `auth`, `executor`)
|
|
130
130
|
- If reverting a **single commit**: `revert({scope}): undo {original description}`
|
|
131
131
|
- If reverting **multiple commits**: `revert({scope}): undo {N} commits from {scope}`
|
|
132
132
|
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "pbr",
|
|
3
|
-
"version": "2.56.
|
|
3
|
+
"version": "2.56.3",
|
|
4
4
|
"description": "Plan-Build-Run — Structured development workflow for Claude Code. Solves context rot through disciplined subagent delegation, structured planning, atomic execution, and goal-backward verification.",
|
|
5
5
|
"author": {
|
|
6
6
|
"name": "SienkLogic",
|
|
@@ -109,7 +109,7 @@ One task = one commit. Exception: TDD tasks get 3 commits (RED, GREEN, REFACTOR)
|
|
|
109
109
|
### Commit Format
|
|
110
110
|
|
|
111
111
|
```
|
|
112
|
-
{type}({
|
|
112
|
+
{type}({scope}): {description}
|
|
113
113
|
```
|
|
114
114
|
|
|
115
115
|
| Type | When |
|
|
@@ -128,7 +128,7 @@ Stage only files listed in the task's `<files>`. If git commit fails with lock e
|
|
|
128
128
|
When the plan frontmatter contains a non-empty `closes_issues` array, append issue-closing syntax to the **final** commit body for the plan:
|
|
129
129
|
|
|
130
130
|
```
|
|
131
|
-
git commit -m "feat(
|
|
131
|
+
git commit -m "feat(auth): implement user auth
|
|
132
132
|
|
|
133
133
|
Closes #42
|
|
134
134
|
Closes #57"
|
|
@@ -226,9 +226,9 @@ When a task has `tdd="true"`, follow Red-Green-Refactor:
|
|
|
226
226
|
|
|
227
227
|
| Phase | Action | Test Must | Commit | If Wrong |
|
|
228
228
|
|-------|--------|-----------|--------|----------|
|
|
229
|
-
| RED | Write test from `<done>` | FAIL | `test(
|
|
230
|
-
| GREEN | Minimal code to pass | PASS | `
|
|
231
|
-
| REFACTOR | Clean up, keep behavior | PASS | `refactor(
|
|
229
|
+
| RED | Write test from `<done>` | FAIL | `test({scope}): RED - ...` | Passes? Fix test. |
|
|
230
|
+
| GREEN | Minimal code to pass | PASS | `refactor({scope}): GREEN - ...` | Fails? Fix code. |
|
|
231
|
+
| REFACTOR | Clean up, keep behavior | PASS | `refactor({scope}): REFACTOR - ...` | Breaks? Revert. |
|
|
232
232
|
|
|
233
233
|
---
|
|
234
234
|
|
|
@@ -59,7 +59,7 @@ This agent is available for ad-hoc `Task()` calls from skills or custom orchestr
|
|
|
59
59
|
|
|
60
60
|
All commits follow: `{type}({scope}): {description}`
|
|
61
61
|
- **Types**: feat, fix, refactor, test, docs, chore, wip
|
|
62
|
-
- **Scopes**:
|
|
62
|
+
- **Scopes**: descriptive word (e.g., `auth`, `api`, `executor`), `quick-{NNN}`, `planning`
|
|
63
63
|
|
|
64
64
|
## Self-Escalation
|
|
65
65
|
|
|
@@ -105,7 +105,7 @@ Condensed from the 3,100-line `docs/DEVELOPMENT-GUIDE.md`. When in doubt, these
|
|
|
105
105
|
|
|
106
106
|
56. Format: `{type}({scope}): {description}`.
|
|
107
107
|
57. Valid types: `feat`, `fix`, `refactor`, `test`, `docs`, `chore`, `wip`.
|
|
108
|
-
58. Valid scopes: `
|
|
108
|
+
58. Valid scopes: a short descriptive word for what changed (e.g., `auth`, `executor`, `config`), `quick-{NNN}`, `planning`, or `{NN}-{MM}` (phase-plan, legacy).
|
|
109
109
|
59. **Never** use `git add .` or `git add -A` — stage specific files only.
|
|
110
110
|
60. Blocked files: `.env` (not `.env.example`), `*.key`, `*.pem`, `*.pfx`, `*.p12`, `*credential*`, `*secret*` (unless in `tests/` or `*.example`).
|
|
111
111
|
61. TDD tasks: exactly 3 commits — RED (test), GREEN (feat), REFACTOR.
|
|
@@ -151,7 +151,7 @@ Controls git integration and branching strategy.
|
|
|
151
151
|
| Property | Type | Default | Description |
|
|
152
152
|
|----------|------|---------|-------------|
|
|
153
153
|
| `branching` | string | `none` | Branching strategy: `none`, `phase`, `milestone`, `disabled` |
|
|
154
|
-
| `commit_format` | string | `{type}({
|
|
154
|
+
| `commit_format` | string | `{type}({scope}): {description}` | Commit message template. Use a short descriptive word as the scope (e.g., `auth`, `config`, `executor`) rather than phase-plan numbers. |
|
|
155
155
|
| `phase_branch_template` | string | `plan-build-run/phase-{phase}-{slug}` | Phase branch name pattern |
|
|
156
156
|
| `milestone_branch_template` | string | `plan-build-run/{milestone}-{slug}` | Milestone branch name pattern |
|
|
157
157
|
| `mode` | string | `enabled` | Git mode: `enabled` or `disabled` |
|
|
@@ -7,23 +7,22 @@ Plan-Build-Run's commit conventions, commit points, branching strategy, and hook
|
|
|
7
7
|
## Commit Message Format
|
|
8
8
|
|
|
9
9
|
```
|
|
10
|
-
{type}({
|
|
10
|
+
{type}({scope}): {description}
|
|
11
11
|
```
|
|
12
12
|
|
|
13
13
|
### Components
|
|
14
14
|
|
|
15
15
|
| Part | Description | Example |
|
|
16
16
|
|------|-------------|---------|
|
|
17
|
-
| `{type}` | Conventional commit type | `feat`, `fix`, `
|
|
18
|
-
| `{
|
|
19
|
-
| `{
|
|
20
|
-
| `{description}` | Imperative, lowercase description | `implement discord oauth client` |
|
|
17
|
+
| `{type}` | Conventional commit type | `feat`, `fix`, `chore` |
|
|
18
|
+
| `{scope}` | Descriptive word for the area of change | `auth`, `executor`, `changelog` |
|
|
19
|
+
| `{description}` | Imperative, lowercase description | `add discord oauth flow` |
|
|
21
20
|
|
|
22
|
-
The format is configurable via `config.json` at `git.commit_format`. The default is `{type}({
|
|
21
|
+
The format is configurable via `config.json` at `git.commit_format`. The default is `{type}({scope}): {description}`.
|
|
23
22
|
|
|
24
23
|
### Full Example
|
|
25
24
|
```
|
|
26
|
-
feat(
|
|
25
|
+
feat(auth): implement discord oauth client
|
|
27
26
|
```
|
|
28
27
|
|
|
29
28
|
---
|
|
@@ -32,19 +31,35 @@ feat(02-01): implement discord oauth client
|
|
|
32
31
|
|
|
33
32
|
| Type | When to Use | Example |
|
|
34
33
|
|------|------------|---------|
|
|
35
|
-
| `feat` | New feature or functionality | `feat(
|
|
36
|
-
| `fix` | Bug fix (including during execution) | `fix(
|
|
37
|
-
| `refactor` | Code restructuring, no behavior change | `refactor(
|
|
38
|
-
| `test` | Adding or modifying tests | `test(
|
|
39
|
-
| `docs` | Documentation changes | `docs(
|
|
40
|
-
| `chore` | Build config, dependencies, tooling | `chore(
|
|
41
|
-
| `style` | Formatting, whitespace (no logic change) | `style(
|
|
34
|
+
| `feat` | New feature or functionality | `feat(auth): implement discord oauth client` |
|
|
35
|
+
| `fix` | Bug fix (including during execution) | `fix(api): handle null user profile from discord` |
|
|
36
|
+
| `refactor` | Code restructuring, no behavior change | `refactor(auth): extract token validation into helper` |
|
|
37
|
+
| `test` | Adding or modifying tests | `test(auth): add failing tests for oauth flow` |
|
|
38
|
+
| `docs` | Documentation changes | `docs(planning): add api endpoint documentation` |
|
|
39
|
+
| `chore` | Build config, dependencies, tooling | `chore(deps): configure typescript and eslint` |
|
|
40
|
+
| `style` | Formatting, whitespace (no logic change) | `style(auth): fix import ordering` |
|
|
41
|
+
|
|
42
|
+
---
|
|
43
|
+
|
|
44
|
+
## Commit Type Discipline
|
|
45
|
+
|
|
46
|
+
| Type | Use For | Appears in Changelog |
|
|
47
|
+
|------|---------|---------------------|
|
|
48
|
+
| `feat` | User-visible features ONLY (new commands, new config options, changed behavior users notice) | YES |
|
|
49
|
+
| `fix` | Bug fixes users would notice | YES |
|
|
50
|
+
| `refactor` | Internal restructuring, TDD GREEN commits, code cleanup | No |
|
|
51
|
+
| `test` | Test additions including TDD RED commits | No |
|
|
52
|
+
| `docs` | Documentation (hidden — mostly planning artifacts) | No |
|
|
53
|
+
| `chore` | Build config, deps, tooling, internal scaffolding | No |
|
|
54
|
+
| `wip` | Work in progress (use sparingly) | No |
|
|
55
|
+
|
|
56
|
+
**TDD commits**: RED phase → `test({scope}): RED - ...`, GREEN phase → `refactor({scope}): GREEN - ...`, REFACTOR phase → `refactor({scope}): REFACTOR - ...`
|
|
42
57
|
|
|
43
58
|
---
|
|
44
59
|
|
|
45
60
|
## Special Commit Scopes
|
|
46
61
|
|
|
47
|
-
Beyond
|
|
62
|
+
Beyond descriptive scopes, Plan-Build-Run recognizes these additional patterns:
|
|
48
63
|
|
|
49
64
|
| Pattern | When Used | Example |
|
|
50
65
|
|---------|-----------|---------|
|
|
@@ -84,9 +99,9 @@ Each successfully completed plan task gets exactly one atomic commit. No more, n
|
|
|
84
99
|
TDD tasks (`tdd="true"`) produce exactly 3 commits following Red-Green-Refactor:
|
|
85
100
|
|
|
86
101
|
```
|
|
87
|
-
test(
|
|
88
|
-
|
|
89
|
-
refactor(
|
|
102
|
+
test(auth): RED - add failing tests for auth middleware
|
|
103
|
+
refactor(auth): GREEN - implement auth middleware to pass tests
|
|
104
|
+
refactor(auth): REFACTOR - extract token verification helper
|
|
90
105
|
```
|
|
91
106
|
|
|
92
107
|
### Commit Preconditions
|
|
@@ -125,15 +140,15 @@ When an executor applies a deviation rule during a task, the deviation is includ
|
|
|
125
140
|
```bash
|
|
126
141
|
# Standard task
|
|
127
142
|
git add src/auth/discord.ts src/auth/types.ts
|
|
128
|
-
git commit -m "feat(
|
|
143
|
+
git commit -m "feat(auth): implement Discord OAuth client with token exchange"
|
|
129
144
|
|
|
130
145
|
# Task that also installed a dependency (Rule 2)
|
|
131
146
|
git add src/auth/discord.ts src/auth/types.ts package.json package-lock.json
|
|
132
|
-
git commit -m "feat(
|
|
147
|
+
git commit -m "feat(auth): implement Discord OAuth client with token exchange"
|
|
133
148
|
|
|
134
149
|
# TDD RED
|
|
135
150
|
git add tests/auth/discord.test.ts
|
|
136
|
-
git commit -m "test(
|
|
151
|
+
git commit -m "test(auth): add failing tests for Discord OAuth flow"
|
|
137
152
|
```
|
|
138
153
|
|
|
139
154
|
---
|
|
@@ -44,7 +44,7 @@
|
|
|
44
44
|
},
|
|
45
45
|
"git": {
|
|
46
46
|
"branching": "none",
|
|
47
|
-
"commit_format": "{type}({
|
|
47
|
+
"commit_format": "{type}({scope}): {description}",
|
|
48
48
|
"phase_branch_template": "plan-build-run/phase-{phase}-{slug}",
|
|
49
49
|
"milestone_branch_template": "plan-build-run/{milestone}-{slug}",
|
|
50
50
|
"mode": "enabled"
|
|
@@ -65,9 +65,9 @@ Present grouped output:
|
|
|
65
65
|
```
|
|
66
66
|
Recent PBR commits (grouped by scope):
|
|
67
67
|
|
|
68
|
-
[
|
|
69
|
-
abc1234 feat(
|
|
70
|
-
def5678 chore(
|
|
68
|
+
[undo]
|
|
69
|
+
abc1234 feat(undo): add undo skill
|
|
70
|
+
def5678 chore(undo): register undo command
|
|
71
71
|
|
|
72
72
|
[quick-003]
|
|
73
73
|
ghi9012 fix(quick-003): fix hook path resolution
|
|
@@ -76,7 +76,7 @@ Recent PBR commits (grouped by scope):
|
|
|
76
76
|
jkl3456 docs(planning): update roadmap phase 55
|
|
77
77
|
```
|
|
78
78
|
|
|
79
|
-
For phase-plan scopes (NN-MM pattern), add a "Phase NN, Plan MM" annotation.
|
|
79
|
+
For descriptive scopes, show just the scope label. For phase-plan scopes (NN-MM pattern, from older commits), add a "Phase NN, Plan MM" annotation.
|
|
80
80
|
|
|
81
81
|
---
|
|
82
82
|
|
|
@@ -104,8 +104,8 @@ Display the commits that will be reverted:
|
|
|
104
104
|
```
|
|
105
105
|
The following commits will be reverted (using git revert, NOT git reset):
|
|
106
106
|
|
|
107
|
-
abc1234 feat(
|
|
108
|
-
def5678 chore(
|
|
107
|
+
abc1234 feat(undo): add undo skill
|
|
108
|
+
def5678 chore(undo): register undo command
|
|
109
109
|
|
|
110
110
|
This creates new revert commits — your history is preserved.
|
|
111
111
|
```
|
|
@@ -127,7 +127,7 @@ git revert --no-commit {hash}
|
|
|
127
127
|
```
|
|
128
128
|
|
|
129
129
|
After all reverts are staged, determine the commit message:
|
|
130
|
-
- Extract scope from the first commit being reverted (e.g., `
|
|
130
|
+
- Extract scope from the first commit being reverted (e.g., `undo`, `auth`, `executor`)
|
|
131
131
|
- If reverting a **single commit**: `revert({scope}): undo {original description}`
|
|
132
132
|
- If reverting **multiple commits**: `revert({scope}): undo {N} commits from {scope}`
|
|
133
133
|
|