@starlein/paperclip-plugin-company-wizard 0.3.21 → 0.3.23
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 +554 -0
- package/CONTRIBUTING.md +90 -0
- package/README.md +2 -1
- package/dist/manifest.js +1 -1
- package/dist/manifest.js.map +1 -1
- package/dist/worker.js +48 -4
- package/dist/worker.js.map +2 -2
- package/package.json +4 -2
- package/templates/modules/pr-review/agents/code-reviewer/skills/code-review.md +1 -1
- package/templates/modules/pr-review/agents/devops/skills/infra-review.md +1 -1
- package/templates/modules/pr-review/agents/engineer/skills/pr-workflow.md +1 -1
- package/templates/modules/pr-review/agents/product-owner/skills/product-review.md +1 -1
- package/templates/modules/pr-review/agents/qa/skills/qa-review.md +1 -1
- package/templates/modules/pr-review/agents/ui-designer/skills/design-review.md +1 -1
- package/templates/modules/pr-review/agents/ux-researcher/skills/ux-review.md +1 -1
- package/templates/modules/pr-review/docs/pr-conventions.md +19 -1
- package/templates/roles/code-reviewer/AGENTS.md +1 -1
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@starlein/paperclip-plugin-company-wizard",
|
|
3
|
-
"version": "0.3.
|
|
3
|
+
"version": "0.3.23",
|
|
4
4
|
"type": "module",
|
|
5
5
|
"description": "AI-powered wizard to bootstrap paperclip agent companies from composable templates (for latest paperclip version)",
|
|
6
6
|
"repository": "https://github.com/starlein/paperclip-plugin-company-wizard",
|
|
@@ -28,7 +28,9 @@
|
|
|
28
28
|
},
|
|
29
29
|
"files": [
|
|
30
30
|
"dist/",
|
|
31
|
-
"templates/"
|
|
31
|
+
"templates/",
|
|
32
|
+
"CHANGELOG.md",
|
|
33
|
+
"CONTRIBUTING.md"
|
|
32
34
|
],
|
|
33
35
|
"paperclipPlugin": {
|
|
34
36
|
"manifest": "./dist/manifest.js",
|
|
@@ -18,7 +18,7 @@ You review PRs for correctness, security, code quality, and simplicity. You are
|
|
|
18
18
|
2. Record your verdict on your review stage:
|
|
19
19
|
- **approved** if the code meets quality standards
|
|
20
20
|
- **changes_requested** with specific, actionable feedback if not
|
|
21
|
-
3. Optionally mirror the
|
|
21
|
+
3. Optionally mirror the verdict as a GitHub PR comment — write it to a Markdown file (open with a heading like `## ✅ Approved` or `## 🔄 Changes requested`, then the details) and run `gh pr comment <number> --body-file <file>`. Never use inline `--body "..."`: a double-quoted shell string keeps `\n` literal, so the comment renders as `text\ntext`. See `docs/pr-conventions.md` → *Posting PR Bodies & Comments*.
|
|
22
22
|
|
|
23
23
|
## Rules
|
|
24
24
|
|
|
@@ -19,7 +19,7 @@ You review PRs for infrastructure impact, performance, security, and operational
|
|
|
19
19
|
3. Record your verdict on your review stage:
|
|
20
20
|
- **approved** if operationally sound
|
|
21
21
|
- **changes_requested** with specific concerns if not
|
|
22
|
-
4. Optionally mirror the
|
|
22
|
+
4. Optionally mirror the verdict as a GitHub PR comment — write it to a Markdown file (open with a heading like `## ✅ Approved` or `## 🔄 Changes requested`, then the details) and run `gh pr comment <number> --body-file <file>`. Never use inline `--body "..."`: a double-quoted shell string keeps `\n` literal, so the comment renders as `text\ntext`. See `docs/pr-conventions.md` → *Posting PR Bodies & Comments*.
|
|
23
23
|
|
|
24
24
|
## Rules
|
|
25
25
|
|
|
@@ -8,7 +8,7 @@ When this skill is active, you work in feature branches and open PRs instead of
|
|
|
8
8
|
2. Create branch: `git checkout -b <prefix>-<N>/<short-description>`
|
|
9
9
|
3. Make your changes, commit with Conventional Commits format
|
|
10
10
|
4. Push branch: `git push -u origin <branch-name>`
|
|
11
|
-
5. Open PR: `gh pr create --title "<type>: <description>" --body
|
|
11
|
+
5. Open PR: write the body (PR Body Template in `docs/pr-conventions.md`) to a file, then `gh pr create --title "<type>: <description>" --body-file <file>`. Never inline `--body "..."` — a double-quoted shell string keeps `\n` literal and the PR renders as `text\ntext` (see *Posting PR Bodies & Comments*).
|
|
12
12
|
6. Set the originating issue's `executionPolicy` to gate the merge on review, ending with your own merge gate:
|
|
13
13
|
- One `review` stage with the **Code Reviewer** as participant (always).
|
|
14
14
|
- Additional `review` stages for any relevant domain reviewer that exists in the team (UI Designer for UI diffs, UX Researcher for flow changes, QA for logic/test-sensitive changes, DevOps for infra/deploy/dependency changes).
|
|
@@ -17,7 +17,7 @@ You review PRs for intent alignment, scope discipline, and acceptance criteria.
|
|
|
17
17
|
2. Record your verdict on your approval stage:
|
|
18
18
|
- **approved** if the change meets product requirements
|
|
19
19
|
- **changes_requested** with specific feedback tied to acceptance criteria
|
|
20
|
-
3. Optionally mirror the
|
|
20
|
+
3. Optionally mirror the verdict as a GitHub PR comment — write it to a Markdown file (open with a heading like `## ✅ Approved` or `## 🔄 Changes requested`, then the details) and run `gh pr comment <number> --body-file <file>`. Never use inline `--body "..."`: a double-quoted shell string keeps `\n` literal, so the comment renders as `text\ntext`. See `docs/pr-conventions.md` → *Posting PR Bodies & Comments*.
|
|
21
21
|
|
|
22
22
|
## Rules
|
|
23
23
|
|
|
@@ -19,7 +19,7 @@ You review PRs for test coverage, edge cases, and regression risk. When a PR cha
|
|
|
19
19
|
3. Record your verdict on your review stage:
|
|
20
20
|
- **approved** if quality is adequate
|
|
21
21
|
- **changes_requested** with specific gaps and suggested test cases if not
|
|
22
|
-
4. Optionally mirror the
|
|
22
|
+
4. Optionally mirror the verdict as a GitHub PR comment — write it to a Markdown file (open with a heading like `## ✅ Approved` or `## 🔄 Changes requested`, then the details) and run `gh pr comment <number> --body-file <file>`. Never use inline `--body "..."`: a double-quoted shell string keeps `\n` literal, so the comment renders as `text\ntext`. See `docs/pr-conventions.md` → *Posting PR Bodies & Comments*.
|
|
23
23
|
|
|
24
24
|
## Rules
|
|
25
25
|
|
|
@@ -19,7 +19,7 @@ You review PRs for visual quality, brand consistency, and accessibility. When a
|
|
|
19
19
|
3. Record your verdict on your review stage:
|
|
20
20
|
- **approved** if visually sound
|
|
21
21
|
- **changes_requested** with specific, actionable feedback if not
|
|
22
|
-
4. Optionally mirror the
|
|
22
|
+
4. Optionally mirror the verdict as a GitHub PR comment — write it to a Markdown file (open with a heading like `## ✅ Approved` or `## 🔄 Changes requested`, then the details) and run `gh pr comment <number> --body-file <file>`. Never use inline `--body "..."`: a double-quoted shell string keeps `\n` literal, so the comment renders as `text\ntext`. See `docs/pr-conventions.md` → *Posting PR Bodies & Comments*.
|
|
23
23
|
|
|
24
24
|
## Rules
|
|
25
25
|
|
|
@@ -19,7 +19,7 @@ You review PRs for usability, user flow integrity, and alignment with user needs
|
|
|
19
19
|
3. Record your verdict on your review stage:
|
|
20
20
|
- **approved** if usability is sound
|
|
21
21
|
- **changes_requested** with specific, actionable feedback if not
|
|
22
|
-
4. Optionally mirror the
|
|
22
|
+
4. Optionally mirror the verdict as a GitHub PR comment — write it to a Markdown file (open with a heading like `## ✅ Approved` or `## 🔄 Changes requested`, then the details) and run `gh pr comment <number> --body-file <file>`. Never use inline `--body "..."`: a double-quoted shell string keeps `\n` literal, so the comment renders as `text\ntext`. See `docs/pr-conventions.md` → *Posting PR Bodies & Comments*.
|
|
23
23
|
|
|
24
24
|
## Rules
|
|
25
25
|
|
|
@@ -38,6 +38,24 @@ Rules: lowercase after colon, no period, under 72 chars.
|
|
|
38
38
|
Closes [PREFIX-N]
|
|
39
39
|
```
|
|
40
40
|
|
|
41
|
+
## Posting PR Bodies & Comments
|
|
42
|
+
|
|
43
|
+
Always pass Markdown through a **file** (`--body-file`), never an inline `--body "..."`. A double-quoted shell argument does **not** turn `\n` into a real newline, so an inline body renders on GitHub as literal `text\ntext\ntext` instead of formatted Markdown. Write the body to a file first:
|
|
44
|
+
|
|
45
|
+
```bash
|
|
46
|
+
# Real newlines + full Markdown (headings, lists, code blocks) preserved.
|
|
47
|
+
cat > /tmp/pr-body.md <<'EOF'
|
|
48
|
+
## What changed
|
|
49
|
+
...
|
|
50
|
+
EOF
|
|
51
|
+
|
|
52
|
+
gh pr create --title "<type>: <description>" --body-file /tmp/pr-body.md
|
|
53
|
+
gh pr comment <number> --body-file /tmp/pr-body.md
|
|
54
|
+
gh pr review <number> --request-changes --body-file /tmp/pr-body.md
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
Every PR comment opens with a Markdown heading stating the verdict (`## ✅ Approved`, `## 🔄 Changes requested`, or `## 💬 Review notes`), followed by a short summary and bullet points or code blocks.
|
|
58
|
+
|
|
41
59
|
## Labels
|
|
42
60
|
|
|
43
61
|
Apply one primary label: `feature`, `bug`, `docs`, `chore`, `infra`, `agent`.
|
|
@@ -52,7 +70,7 @@ Review runs through the issue's native `executionPolicy` (stages), not separate
|
|
|
52
70
|
4. **Code Reviewer** reviews for correctness, security, code style, simplicity and records `approved` / `changes_requested` on the review stage.
|
|
53
71
|
5. **Domain reviewers** (when present as stages) review their concern and record their verdict.
|
|
54
72
|
6. **Product Owner** reviews for intent match, scope discipline, acceptance criteria, and records the final `approval` verdict.
|
|
55
|
-
7. Verdicts are recorded on the stages and may be mirrored as PR comments.
|
|
73
|
+
7. Verdicts are recorded on the stages and may be mirrored as PR comments (always via `--body-file`; see *Posting PR Bodies & Comments*).
|
|
56
74
|
8. **Engineer** owns the final `approval` stage (merge gate): once every reviewer and the Product Owner has approved, the engineer is woken last, merges the PR, confirms the merge landed, and only then records `approved` — which closes the originating issue to `done`. The merge must happen before the issue is `done`.
|
|
57
75
|
|
|
58
76
|
## Review Roles
|
|
@@ -15,7 +15,7 @@ You report to the CEO.
|
|
|
15
15
|
- **Security**: Any injection, XSS, credential exposure, or OWASP risks?
|
|
16
16
|
- **Style**: Consistent with existing codebase patterns?
|
|
17
17
|
- **Simplicity**: Is there unnecessary complexity? Could it be simpler?
|
|
18
|
-
6. Post your review
|
|
18
|
+
6. Post your review: `gh pr review <number> --approve`, or to request changes write your feedback to a Markdown file (start with a heading, e.g. `## 🔄 Changes requested`) and run `gh pr review <number> --request-changes --body-file <file>`. Never inline `--body "..."` — a double-quoted shell string keeps `\n` literal, so the comment renders as `text\ntext` instead of formatted Markdown.
|
|
19
19
|
7. Post your verdict on the originating issue.
|
|
20
20
|
8. Mark your issue as `done`.
|
|
21
21
|
|