@pigcloud/skills 1.0.10 → 1.1.2
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 +25 -20
- package/README.en.md +41 -75
- package/README.md +26 -39
- package/bin/cli.js +282 -188
- package/bin/rules-loader.js +271 -484
- package/codex-commands/README.md +25 -23
- package/codex-commands/commands/analyze.md +21 -22
- package/codex-commands/commands/build.md +22 -22
- package/codex-commands/commands/design.md +21 -22
- package/codex-commands/commands/distill.md +21 -21
- package/codex-commands/commands/doc.md +21 -22
- package/codex-commands/commands/infra.md +21 -21
- package/codex-commands/commands/init.md +20 -20
- package/codex-commands/commands/kb.md +21 -20
- package/codex-commands/commands/perf.md +21 -21
- package/codex-commands/commands/prd.md +21 -22
- package/codex-commands/commands/review.md +21 -22
- package/codex-commands/commands/security.md +21 -22
- package/codex-commands/commands/test.md +21 -21
- package/codex-commands/commands/workflow.md +21 -20
- package/package.json +5 -2
- package/rules/core/index.md +26 -41
- package/rules/delivery/index.md +25 -0
- package/rules/design/index.md +25 -0
- package/rules/discovery/index.md +25 -0
- package/rules/implementation/index.md +25 -0
- package/rules/index.md +24 -39
- package/rules/overlays/index.md +19 -19
- package/rules/overlays/pig-cloud.md +20 -45
- package/rules/shared/index.md +25 -0
- package/rules/skill-stage-map.json +26 -0
- package/rules/stages.json +48 -0
- package/rules/validation/index.md +25 -0
- package/scripts/add-skill-reference-nav.js +3 -0
- package/scripts/bootstrap-skill-specs.js +96 -0
- package/scripts/ci-validator.sh +51 -114
- package/scripts/generate-skill-prompt-library.js +3 -0
- package/scripts/golden-prompt-suite.current.js +211 -0
- package/scripts/migrate-skill-packages.js +309 -0
- package/scripts/run-golden-replays.js +110 -79
- package/scripts/validate-rules.js +128 -125
- package/scripts/validate-skill-replay-signals.js +45 -57
- package/scripts/validate-skill-shapes.js +153 -127
- package/scripts/validate-skill-stop-rules.js +54 -46
- package/skills/01-discovery/ambiguity-detection/SKILL.md +30 -0
- package/skills/01-discovery/ambiguity-detection/assets/golden-prompt-suite.current.js +22 -0
- package/skills/01-discovery/ambiguity-detection/references/README.md +17 -0
- package/skills/01-discovery/ambiguity-detection/references/cases.md +26 -0
- package/skills/01-discovery/ambiguity-detection/references/prompt-template.md +18 -0
- package/skills/01-discovery/ambiguity-detection/skill-spec.json +26 -0
- package/skills/01-discovery/business-analysis/SKILL.md +30 -0
- package/skills/01-discovery/business-analysis/assets/golden-prompt-suite.current.js +22 -0
- package/skills/01-discovery/business-analysis/references/README.md +17 -0
- package/skills/01-discovery/business-analysis/references/cases.md +26 -0
- package/skills/01-discovery/business-analysis/references/prompt-template.md +18 -0
- package/skills/01-discovery/business-analysis/skill-spec.json +26 -0
- package/skills/01-discovery/impact-analysis/SKILL.md +30 -0
- package/skills/01-discovery/impact-analysis/assets/golden-prompt-suite.current.js +22 -0
- package/skills/01-discovery/impact-analysis/references/README.md +17 -0
- package/skills/01-discovery/impact-analysis/references/cases.md +26 -0
- package/skills/01-discovery/impact-analysis/references/prompt-template.md +18 -0
- package/skills/01-discovery/impact-analysis/skill-spec.json +26 -0
- package/skills/01-discovery/requirement-discovery/SKILL.md +30 -0
- package/skills/01-discovery/requirement-discovery/assets/golden-prompt-suite.current.js +24 -0
- package/skills/01-discovery/requirement-discovery/references/README.md +17 -0
- package/skills/01-discovery/requirement-discovery/references/cases.md +28 -0
- package/skills/01-discovery/requirement-discovery/references/prompt-template.md +18 -0
- package/skills/01-discovery/requirement-discovery/skill-spec.json +26 -0
- package/skills/02-design/api-design/SKILL.md +29 -0
- package/skills/02-design/api-design/assets/golden-prompt-suite.current.js +22 -0
- package/skills/02-design/api-design/references/README.md +17 -0
- package/skills/02-design/api-design/references/cases.md +26 -0
- package/skills/02-design/api-design/references/prompt-template.md +18 -0
- package/skills/02-design/api-design/skill-spec.json +25 -0
- package/skills/02-design/architecture-design/SKILL.md +29 -0
- package/skills/02-design/architecture-design/assets/golden-prompt-suite.current.js +22 -0
- package/skills/02-design/architecture-design/references/README.md +17 -0
- package/skills/02-design/architecture-design/references/cases.md +26 -0
- package/skills/02-design/architecture-design/references/prompt-template.md +18 -0
- package/skills/02-design/architecture-design/skill-spec.json +25 -0
- package/skills/02-design/database-design/SKILL.md +29 -0
- package/skills/02-design/database-design/assets/golden-prompt-suite.current.js +22 -0
- package/skills/02-design/database-design/references/README.md +17 -0
- package/skills/02-design/database-design/references/cases.md +26 -0
- package/skills/02-design/database-design/references/prompt-template.md +18 -0
- package/skills/02-design/database-design/skill-spec.json +25 -0
- package/skills/02-design/task-breakdown/SKILL.md +29 -0
- package/skills/02-design/task-breakdown/assets/golden-prompt-suite.current.js +22 -0
- package/skills/02-design/task-breakdown/references/README.md +17 -0
- package/skills/02-design/task-breakdown/references/cases.md +26 -0
- package/skills/02-design/task-breakdown/references/prompt-template.md +18 -0
- package/skills/02-design/task-breakdown/skill-spec.json +25 -0
- package/skills/03-implementation/backend-development/SKILL.md +29 -0
- package/skills/03-implementation/backend-development/assets/golden-prompt-suite.current.js +22 -0
- package/skills/03-implementation/backend-development/references/README.md +17 -0
- package/skills/03-implementation/backend-development/references/cases.md +26 -0
- package/skills/03-implementation/backend-development/references/prompt-template.md +18 -0
- package/skills/03-implementation/backend-development/skill-spec.json +25 -0
- package/skills/03-implementation/bug-fix/SKILL.md +29 -0
- package/skills/03-implementation/bug-fix/assets/golden-prompt-suite.current.js +22 -0
- package/skills/03-implementation/bug-fix/references/README.md +17 -0
- package/skills/03-implementation/bug-fix/references/cases.md +26 -0
- package/skills/03-implementation/bug-fix/references/prompt-template.md +18 -0
- package/skills/03-implementation/bug-fix/skill-spec.json +25 -0
- package/skills/03-implementation/database-change/SKILL.md +29 -0
- package/skills/03-implementation/database-change/assets/golden-prompt-suite.current.js +22 -0
- package/skills/03-implementation/database-change/references/README.md +17 -0
- package/skills/03-implementation/database-change/references/cases.md +26 -0
- package/skills/03-implementation/database-change/references/prompt-template.md +18 -0
- package/skills/03-implementation/database-change/skill-spec.json +25 -0
- package/skills/03-implementation/frontend-development/SKILL.md +29 -0
- package/skills/03-implementation/frontend-development/assets/golden-prompt-suite.current.js +22 -0
- package/skills/03-implementation/frontend-development/references/README.md +17 -0
- package/skills/03-implementation/frontend-development/references/cases.md +26 -0
- package/skills/03-implementation/frontend-development/references/prompt-template.md +18 -0
- package/skills/03-implementation/frontend-development/skill-spec.json +25 -0
- package/skills/04-validation/code-review/SKILL.md +29 -0
- package/skills/04-validation/code-review/assets/golden-prompt-suite.current.js +22 -0
- package/skills/04-validation/code-review/references/README.md +17 -0
- package/skills/04-validation/code-review/references/cases.md +26 -0
- package/skills/04-validation/code-review/references/prompt-template.md +18 -0
- package/skills/04-validation/code-review/skill-spec.json +25 -0
- package/skills/04-validation/performance-review/SKILL.md +29 -0
- package/skills/04-validation/performance-review/assets/golden-prompt-suite.current.js +22 -0
- package/skills/04-validation/performance-review/references/README.md +17 -0
- package/skills/04-validation/performance-review/references/cases.md +26 -0
- package/skills/04-validation/performance-review/references/prompt-template.md +18 -0
- package/skills/04-validation/performance-review/skill-spec.json +25 -0
- package/skills/04-validation/regression-check/SKILL.md +29 -0
- package/skills/04-validation/regression-check/assets/golden-prompt-suite.current.js +22 -0
- package/skills/04-validation/regression-check/references/README.md +17 -0
- package/skills/04-validation/regression-check/references/cases.md +26 -0
- package/skills/04-validation/regression-check/references/prompt-template.md +18 -0
- package/skills/04-validation/regression-check/skill-spec.json +25 -0
- package/skills/04-validation/security-review/SKILL.md +29 -0
- package/skills/04-validation/security-review/assets/golden-prompt-suite.current.js +22 -0
- package/skills/04-validation/security-review/references/README.md +17 -0
- package/skills/04-validation/security-review/references/cases.md +26 -0
- package/skills/04-validation/security-review/references/prompt-template.md +18 -0
- package/skills/04-validation/security-review/skill-spec.json +25 -0
- package/skills/04-validation/unit-test/SKILL.md +29 -0
- package/skills/04-validation/unit-test/assets/golden-prompt-suite.current.js +22 -0
- package/skills/04-validation/unit-test/references/README.md +17 -0
- package/skills/04-validation/unit-test/references/cases.md +26 -0
- package/skills/04-validation/unit-test/references/prompt-template.md +18 -0
- package/skills/04-validation/unit-test/skill-spec.json +25 -0
- package/skills/05-delivery/change-log/SKILL.md +29 -0
- package/skills/05-delivery/change-log/assets/golden-prompt-suite.current.js +22 -0
- package/skills/05-delivery/change-log/references/README.md +17 -0
- package/skills/05-delivery/change-log/references/cases.md +26 -0
- package/skills/05-delivery/change-log/references/prompt-template.md +18 -0
- package/skills/05-delivery/change-log/skill-spec.json +25 -0
- package/skills/05-delivery/deployment-guide/SKILL.md +29 -0
- package/skills/05-delivery/deployment-guide/assets/golden-prompt-suite.current.js +22 -0
- package/skills/05-delivery/deployment-guide/references/README.md +17 -0
- package/skills/05-delivery/deployment-guide/references/cases.md +26 -0
- package/skills/05-delivery/deployment-guide/references/prompt-template.md +18 -0
- package/skills/05-delivery/deployment-guide/skill-spec.json +25 -0
- package/skills/05-delivery/release-check/SKILL.md +29 -0
- package/skills/05-delivery/release-check/assets/golden-prompt-suite.current.js +22 -0
- package/skills/05-delivery/release-check/references/README.md +17 -0
- package/skills/05-delivery/release-check/references/cases.md +26 -0
- package/skills/05-delivery/release-check/references/prompt-template.md +18 -0
- package/skills/05-delivery/release-check/skill-spec.json +25 -0
- package/skills/05-delivery/release-validation/SKILL.md +29 -0
- package/skills/05-delivery/release-validation/assets/golden-prompt-suite.current.js +22 -0
- package/skills/05-delivery/release-validation/references/README.md +17 -0
- package/skills/05-delivery/release-validation/references/cases.md +26 -0
- package/skills/05-delivery/release-validation/references/prompt-template.md +18 -0
- package/skills/05-delivery/release-validation/skill-spec.json +25 -0
- package/skills/shared/codebase-learning/SKILL.md +29 -0
- package/skills/shared/codebase-learning/assets/golden-prompt-suite.current.js +22 -0
- package/skills/shared/codebase-learning/references/README.md +17 -0
- package/skills/shared/codebase-learning/references/cases.md +26 -0
- package/skills/shared/codebase-learning/references/prompt-template.md +18 -0
- package/skills/shared/codebase-learning/skill-spec.json +25 -0
- package/skills/shared/evidence-collector/SKILL.md +29 -0
- package/skills/shared/evidence-collector/assets/golden-prompt-suite.current.js +22 -0
- package/skills/shared/evidence-collector/references/README.md +17 -0
- package/skills/shared/evidence-collector/references/cases.md +26 -0
- package/skills/shared/evidence-collector/references/prompt-template.md +18 -0
- package/skills/shared/evidence-collector/skill-spec.json +25 -0
- package/skills/shared/framework-guide/SKILL.md +28 -0
- package/skills/shared/framework-guide/assets/golden-prompt-suite.current.js +22 -0
- package/skills/shared/framework-guide/references/README.md +17 -0
- package/skills/shared/framework-guide/references/cases.md +26 -0
- package/skills/shared/framework-guide/references/prompt-template.md +18 -0
- package/skills/shared/framework-guide/skill-spec.json +24 -0
- package/rules/bundles.json +0 -358
- package/rules/coding/analysis.md +0 -27
- package/rules/coding/backend/cache-invalidation.md +0 -30
- package/rules/coding/backend/cache-keying.md +0 -30
- package/rules/coding/backend/cache.md +0 -37
- package/rules/coding/backend/database.md +0 -32
- package/rules/coding/backend/feign.md +0 -30
- package/rules/coding/backend/index.md +0 -42
- package/rules/coding/backend/query.md +0 -32
- package/rules/coding/backend/remote.md +0 -33
- package/rules/coding/backend/transaction-boundary.md +0 -30
- package/rules/coding/backend/transaction-rollback.md +0 -30
- package/rules/coding/backend/transaction.md +0 -38
- package/rules/coding/boundary.md +0 -25
- package/rules/coding/implementation.md +0 -26
- package/rules/coding/index.md +0 -38
- package/rules/coding/scaffold.md +0 -28
- package/rules/coding/testing.md +0 -29
- package/rules/coding/validation.md +0 -29
- package/rules/core/code-quality.md +0 -30
- package/rules/core/evidence.md +0 -26
- package/rules/core/interface.md +0 -26
- package/rules/core/iteration.md +0 -26
- package/rules/core/layer-boundary.md +0 -25
- package/rules/core/logging.md +0 -26
- package/rules/core/security.md +0 -26
- package/rules/core/task-boundary.md +0 -27
- package/rules/docs/api.md +0 -34
- package/rules/docs/capture-summary.md +0 -29
- package/rules/docs/capture.md +0 -34
- package/rules/docs/contract.md +0 -30
- package/rules/docs/decision-log.md +0 -32
- package/rules/docs/examples.md +0 -28
- package/rules/docs/index.md +0 -49
- package/rules/docs/reference.md +0 -32
- package/rules/overlays/pig-cloud/controller.md +0 -33
- package/rules/overlays/pig-cloud/dto-vo.md +0 -33
- package/rules/overlays/pig-cloud/entity.md +0 -32
- package/rules/overlays/pig-cloud/exception.md +0 -32
- package/rules/overlays/pig-cloud/layering.md +0 -31
- package/rules/overlays/pig-cloud/mapper.md +0 -32
- package/rules/overlays/pig-cloud/query-style.md +0 -32
- package/rules/overlays/pig-cloud/rest-response.md +0 -33
- package/rules/overlays/pig-cloud/service.md +0 -33
- package/rules/overlays/pig-cloud/transactions.md +0 -32
- package/rules/overlays/pig-cloud/validation.md +0 -33
- package/rules/product/acceptance.md +0 -25
- package/rules/product/briefing.md +0 -27
- package/rules/product/index.md +0 -36
- package/rules/product/intake.md +0 -27
- package/rules/product/modeling.md +0 -25
- package/rules/product/project-context.md +0 -29
- package/rules/review/code.md +0 -35
- package/rules/review/evidence.md +0 -31
- package/rules/review/index.md +0 -50
- package/rules/review/java.md +0 -42
- package/rules/review/performance.md +0 -38
- package/rules/review/rubric.md +0 -28
- package/rules/review/security.md +0 -38
- package/rules/review/ts.md +0 -33
- package/rules/review/vue.md +0 -33
- package/rules/skill-profile-map.json +0 -59
- package/rules/skill-profile-map.md +0 -29
- package/rules/workflow/handoff.md +0 -25
- package/rules/workflow/index.md +0 -37
- package/rules/workflow/refinement.md +0 -29
- package/rules/workflow/router.md +0 -25
- package/rules/workflow/selection.md +0 -25
- package/rules/workflow/stop.md +0 -25
- package/skills/api-contract-docs/SKILL.md +0 -77
- package/skills/business-fact-extraction/SKILL.md +0 -337
- package/skills/business-fact-extraction/scripts/write-knowledge-base.js +0 -228
- package/skills/code-review/SKILL.md +0 -136
- package/skills/code-review/references/findings-template.md +0 -51
- package/skills/code-review/references/performance-checklist.md +0 -213
- package/skills/code-review/references/rubric.md +0 -232
- package/skills/code-review/references/rules.md +0 -32
- package/skills/code-review/references/security-checklist.md +0 -178
- package/skills/code-review/references/stack-notes.md +0 -25
- package/skills/code-review/references/template-review.md +0 -39
- package/skills/code-review/scripts/lint-code-review.mjs +0 -431
- package/skills/domain-modeling/SKILL.md +0 -81
- package/skills/domain-modeling/references/README.md +0 -134
- package/skills/domain-modeling/references/distillation-checklist.md +0 -44
- package/skills/domain-modeling/references/test-cases-template.md +0 -128
- package/skills/environment-deploy/SKILL.md +0 -81
- package/skills/feature-build/SKILL.md +0 -122
- package/skills/feature-build/references/coding-checklist.md +0 -97
- package/skills/feature-build/references/comment-specification.md +0 -89
- package/skills/knowledge-capture/SKILL.md +0 -93
- package/skills/performance-audit/SKILL.md +0 -118
- package/skills/project-bootstrap/SKILL.md +0 -81
- package/skills/references/anti-rationalization.md +0 -144
- package/skills/references/business-fact-extraction.md +0 -415
- package/skills/references/engineering-delivery-method.md +0 -64
- package/skills/references/engineering-delivery-template.md +0 -81
- package/skills/references/golden-prompt-suite.js +0 -436
- package/skills/references/golden-prompt-suite.md +0 -33
- package/skills/references/project-requirement-alignment.md +0 -42
- package/skills/references/rule-loading-map.md +0 -117
- package/skills/references/skill-authoring-standard.md +0 -74
- package/skills/references/skill-boundary-template.md +0 -71
- package/skills/references/skill-enhanced-template.md +0 -103
- package/skills/references/skill-reference-matrix.md +0 -62
- package/skills/security-audit/SKILL.md +0 -119
- package/skills/spec-refinement/SKILL.md +0 -149
- package/skills/technical-design/SKILL.md +0 -106
- package/skills/technical-design/references/solid-checklist.md +0 -199
- package/skills/test-design/SKILL.md +0 -92
- package/skills/workflow-router/SKILL.md +0 -86
package/rules/docs/index.md
DELETED
|
@@ -1,49 +0,0 @@
|
|
|
1
|
-
# Docs Rules
|
|
2
|
-
|
|
3
|
-
`docs/` contains rules for API docs, knowledge capture, and other durable written artifacts.
|
|
4
|
-
|
|
5
|
-
## 默认做法
|
|
6
|
-
|
|
7
|
-
- Keep docs tied to real artifacts.
|
|
8
|
-
- Write for reuse, not for one-off narration.
|
|
9
|
-
- Capture decisions and terms that future work needs.
|
|
10
|
-
- Distinguish reference docs from decision logs.
|
|
11
|
-
- Separate stable contracts from usage examples.
|
|
12
|
-
- Route consumer-facing material to `api` when contract and examples must stay together.
|
|
13
|
-
- Route durable knowledge to `reference` when the material should outlive one change.
|
|
14
|
-
|
|
15
|
-
## 选择
|
|
16
|
-
|
|
17
|
-
- Use `contract` for stable behavior that callers rely on.
|
|
18
|
-
- Use `api` for API-facing docs that need contract plus examples.
|
|
19
|
-
- Use `examples` for usage illustrations that support a contract.
|
|
20
|
-
- Use `reference` for reusable long-lived docs and artifact notes.
|
|
21
|
-
- Use `decision-log` for time-bound decisions and rationale.
|
|
22
|
-
- Use `capture` for context transfer, and `capture-summary` for the smallest reusable handoff note.
|
|
23
|
-
|
|
24
|
-
## 禁区
|
|
25
|
-
|
|
26
|
-
- Do not mix documentation with implementation work.
|
|
27
|
-
- Do not turn docs into a full tutorial when the task only needs a reference.
|
|
28
|
-
- Do not mix stable reference material with time-bound decisions.
|
|
29
|
-
- Do not mix examples with the contract itself when they have different lifecycles.
|
|
30
|
-
|
|
31
|
-
## 检查
|
|
32
|
-
|
|
33
|
-
- Is the doc reusable?
|
|
34
|
-
- Does it point back to the artifact it describes?
|
|
35
|
-
- Does it belong to exactly one lifecycle bucket?
|
|
36
|
-
|
|
37
|
-
## 回放信号
|
|
38
|
-
|
|
39
|
-
- Trigger when the request is about API docs, knowledge notes, or reusable documentation.
|
|
40
|
-
|
|
41
|
-
## References
|
|
42
|
-
|
|
43
|
-
- `docs/api.md`
|
|
44
|
-
- `docs/capture.md`
|
|
45
|
-
- `docs/reference.md`
|
|
46
|
-
- `docs/decision-log.md`
|
|
47
|
-
- `docs/contract.md`
|
|
48
|
-
- `docs/examples.md`
|
|
49
|
-
- `docs/capture-summary.md`
|
package/rules/docs/reference.md
DELETED
|
@@ -1,32 +0,0 @@
|
|
|
1
|
-
# Docs Reference Rules
|
|
2
|
-
|
|
3
|
-
## 默认做法
|
|
4
|
-
|
|
5
|
-
- Write stable reference material for callers and maintainers.
|
|
6
|
-
- Keep reference pages small, reusable, and artifact-backed.
|
|
7
|
-
- Point readers to the source of truth, not the discussion trail.
|
|
8
|
-
- Keep reference pages independent from decision logs and captures.
|
|
9
|
-
- Include only facts that should survive a normal implementation change.
|
|
10
|
-
|
|
11
|
-
## 禁区
|
|
12
|
-
|
|
13
|
-
- Do not bury a reference inside a decision log.
|
|
14
|
-
- Do not invent behavior the code does not support.
|
|
15
|
-
- Do not embed transient decisions into the reference.
|
|
16
|
-
- Do not use reference pages to retell the whole history.
|
|
17
|
-
|
|
18
|
-
## 检查
|
|
19
|
-
|
|
20
|
-
- Is the document stable enough to be reused later?
|
|
21
|
-
- Does it point at the underlying artifact or contract?
|
|
22
|
-
- Is it free of time-bound rationale?
|
|
23
|
-
- Would this still be useful after several code changes?
|
|
24
|
-
- Would a new reader use this without checking recent discussions?
|
|
25
|
-
|
|
26
|
-
## 回放信号
|
|
27
|
-
|
|
28
|
-
- Trigger when the task is about reusable reference material, contracts, or long-lived docs.
|
|
29
|
-
|
|
30
|
-
## References
|
|
31
|
-
|
|
32
|
-
- `docs/index.md`
|
|
@@ -1,33 +0,0 @@
|
|
|
1
|
-
# Pig Cloud Controller 规则
|
|
2
|
-
|
|
3
|
-
`overlays/pig-cloud/controller.md` 定义 Controller 层边界。
|
|
4
|
-
|
|
5
|
-
## 默认做法
|
|
6
|
-
|
|
7
|
-
- Controller 只负责协议接入、参数接收、结果返回。
|
|
8
|
-
- 只做轻量编排,不做业务决策。
|
|
9
|
-
- 返回值默认配合 `rules/overlays/pig-cloud/rest-response.md`。
|
|
10
|
-
|
|
11
|
-
## 禁区
|
|
12
|
-
|
|
13
|
-
- 不要在 Controller 里写业务判断、流程编排或状态机。
|
|
14
|
-
- 不要直接依赖 Mapper 做写入。
|
|
15
|
-
- 不要在这里做异常分类、错误码映射或统一兜底。
|
|
16
|
-
- 不要把 DTO 转换逻辑扩散到多个接口方法里。
|
|
17
|
-
|
|
18
|
-
## 检查
|
|
19
|
-
|
|
20
|
-
- 这个方法是否仍然只是入口?
|
|
21
|
-
- 有没有把业务逻辑、异常处理或持久化操作塞回 Controller?
|
|
22
|
-
- Controller 是否只依赖 Service 和请求/响应模型?
|
|
23
|
-
|
|
24
|
-
## 回放信号
|
|
25
|
-
|
|
26
|
-
- 当新增接口、拆接口、调整入参或更改返回结构时触发。
|
|
27
|
-
|
|
28
|
-
## References
|
|
29
|
-
|
|
30
|
-
- `rules/overlays/pig-cloud.md`
|
|
31
|
-
- `rules/overlays/pig-cloud/layering.md`
|
|
32
|
-
- `rules/overlays/pig-cloud/rest-response.md`
|
|
33
|
-
- `rules/overlays/pig-cloud/exception.md`
|
|
@@ -1,33 +0,0 @@
|
|
|
1
|
-
# Pig Cloud DTO/VO 规则
|
|
2
|
-
|
|
3
|
-
`overlays/pig-cloud/dto-vo.md` 定义 DTO 与 VO 的边界。
|
|
4
|
-
|
|
5
|
-
## 默认做法
|
|
6
|
-
|
|
7
|
-
- DTO 用于输入承接和校验。
|
|
8
|
-
- VO 用于输出展示,不回流成写入对象。
|
|
9
|
-
- 请求模型与响应模型分离。
|
|
10
|
-
|
|
11
|
-
## 禁区
|
|
12
|
-
|
|
13
|
-
- 不要拿实体直接充当接口输入输出。
|
|
14
|
-
- 不要让 DTO、VO、Entity 三者边界混乱。
|
|
15
|
-
- 不要让返回对象反向承担写入语义。
|
|
16
|
-
- 不要把字段补齐逻辑和展示逻辑混进输入模型。
|
|
17
|
-
|
|
18
|
-
## 检查
|
|
19
|
-
|
|
20
|
-
- 这个模型是输入、输出还是持久化实体?
|
|
21
|
-
- 是否存在复用过度导致边界模糊?
|
|
22
|
-
- 是否把展示字段混进了写入模型?
|
|
23
|
-
- 是否把写入字段混进了展示模型?
|
|
24
|
-
|
|
25
|
-
## 回放信号
|
|
26
|
-
|
|
27
|
-
- 当接口模型、字段映射或展示层结构变化时触发。
|
|
28
|
-
|
|
29
|
-
## References
|
|
30
|
-
|
|
31
|
-
- `rules/overlays/pig-cloud.md`
|
|
32
|
-
- `rules/overlays/pig-cloud/rest-response.md`
|
|
33
|
-
- `rules/overlays/pig-cloud/entity.md`
|
|
@@ -1,32 +0,0 @@
|
|
|
1
|
-
# Pig Cloud 实体规则
|
|
2
|
-
|
|
3
|
-
`overlays/pig-cloud/entity.md` 定义实体边界和删除语义。
|
|
4
|
-
|
|
5
|
-
## 默认做法
|
|
6
|
-
|
|
7
|
-
- 逻辑删除语义明确时,使用 `MpLogicDelEntity`。
|
|
8
|
-
- 真实删除语义明确时,使用 `MpRealDelEntity`。
|
|
9
|
-
- 实体设计与删除语义保持一致,不混搭。
|
|
10
|
-
|
|
11
|
-
## 禁区
|
|
12
|
-
|
|
13
|
-
- 不要在同一实体上同时混用真实删除和逻辑删除语义。
|
|
14
|
-
- 不要为删除状态再发明一套平行字段。
|
|
15
|
-
- 不要把删除语义散落到多个层里重复解释。
|
|
16
|
-
- 不要把 Entity 当成接口输入输出对象。
|
|
17
|
-
|
|
18
|
-
## 检查
|
|
19
|
-
|
|
20
|
-
- 这个实体到底是逻辑删除还是物理删除?
|
|
21
|
-
- 删除语义是否在模型层已经说清楚?
|
|
22
|
-
- 是否需要更新相关查询、恢复或审计逻辑?
|
|
23
|
-
- 是否有人把 Entity 直接暴露到 Controller?
|
|
24
|
-
|
|
25
|
-
## 回放信号
|
|
26
|
-
|
|
27
|
-
- 当新增实体、变更删除策略或调整删除字段时触发。
|
|
28
|
-
|
|
29
|
-
## References
|
|
30
|
-
|
|
31
|
-
- `rules/overlays/pig-cloud.md`
|
|
32
|
-
- `rules/index.md`
|
|
@@ -1,32 +0,0 @@
|
|
|
1
|
-
# Pig Cloud Exception 规则
|
|
2
|
-
|
|
3
|
-
`overlays/pig-cloud/exception.md` 定义异常与错误语义。
|
|
4
|
-
|
|
5
|
-
## 默认做法
|
|
6
|
-
|
|
7
|
-
- 业务异常要有稳定语义。
|
|
8
|
-
- 错误输出与 `Result<T>` 的返回约定保持一致。
|
|
9
|
-
- 异常转换尽量集中处理,不要分散到多个层。
|
|
10
|
-
|
|
11
|
-
## 禁区
|
|
12
|
-
|
|
13
|
-
- 不要在接口层随意吞异常。
|
|
14
|
-
- 不要把异常语义写得模糊。
|
|
15
|
-
- 不要让错误码和错误信息各自漂移。
|
|
16
|
-
- 不要把异常处理和 REST 封装逻辑拆成两套平行实现。
|
|
17
|
-
|
|
18
|
-
## 检查
|
|
19
|
-
|
|
20
|
-
- 这个异常是否能被稳定识别?
|
|
21
|
-
- 错误输出是否和返回约定一致?
|
|
22
|
-
- 异常转换是否被重复实现?
|
|
23
|
-
- 是否应当由统一异常出口兜底?
|
|
24
|
-
|
|
25
|
-
## 回放信号
|
|
26
|
-
|
|
27
|
-
- 当业务失败、错误码或异常转换方式变化时触发。
|
|
28
|
-
|
|
29
|
-
## References
|
|
30
|
-
|
|
31
|
-
- `rules/overlays/pig-cloud.md`
|
|
32
|
-
- `rules/overlays/pig-cloud/rest-response.md`
|
|
@@ -1,31 +0,0 @@
|
|
|
1
|
-
# Pig Cloud 分层规则
|
|
2
|
-
|
|
3
|
-
`overlays/pig-cloud/layering.md` 定义本仓库的默认分层形态。
|
|
4
|
-
|
|
5
|
-
## 默认做法
|
|
6
|
-
|
|
7
|
-
- 默认使用 `Controller -> Service -> Mapper`。
|
|
8
|
-
- Controller 只负责接收请求和返回结果。
|
|
9
|
-
- Service 负责业务编排、事务控制和规则聚合。
|
|
10
|
-
- Mapper 只负责持久化访问。
|
|
11
|
-
|
|
12
|
-
## 禁区
|
|
13
|
-
|
|
14
|
-
- 不要把业务逻辑塞进 Controller。
|
|
15
|
-
- 不要把编排逻辑塞进 Mapper。
|
|
16
|
-
- 不要绕过 Service 直接操作持久层完成业务写入。
|
|
17
|
-
|
|
18
|
-
## 检查
|
|
19
|
-
|
|
20
|
-
- 业务流是否仍然是 Controller 进、Service 承接、Mapper 落库?
|
|
21
|
-
- Controller 是否保持轻量?
|
|
22
|
-
- Service 是否承担了应有的编排和事务职责?
|
|
23
|
-
|
|
24
|
-
## 回放信号
|
|
25
|
-
|
|
26
|
-
- 当接口调用链、分层职责或写入路径发生变化时触发。
|
|
27
|
-
|
|
28
|
-
## References
|
|
29
|
-
|
|
30
|
-
- `rules/overlays/pig-cloud.md`
|
|
31
|
-
- `rules/index.md`
|
|
@@ -1,32 +0,0 @@
|
|
|
1
|
-
# Pig Cloud Mapper 规则
|
|
2
|
-
|
|
3
|
-
`overlays/pig-cloud/mapper.md` 定义 Mapper 层边界。
|
|
4
|
-
|
|
5
|
-
## 默认做法
|
|
6
|
-
|
|
7
|
-
- Mapper 只负责数据访问,不承载业务编排。
|
|
8
|
-
- 保持查询和更新风格与 `rules/overlays/pig-cloud/query-style.md` 一致。
|
|
9
|
-
- 访问模型尽量稳定,避免无意义的映射漂移。
|
|
10
|
-
|
|
11
|
-
## 禁区
|
|
12
|
-
|
|
13
|
-
- 不要在 Mapper 中放业务规则。
|
|
14
|
-
- 不要在 Mapper 中管理事务。
|
|
15
|
-
- 不要在 Mapper 中拼 HTTP 或 UI 语义。
|
|
16
|
-
- 不要让接口层绕过 Mapper 去模拟持久化行为。
|
|
17
|
-
|
|
18
|
-
## 检查
|
|
19
|
-
|
|
20
|
-
- 这个方法是不是只做数据访问?
|
|
21
|
-
- 查询和更新风格是否一致?
|
|
22
|
-
- 有没有把业务逻辑下沉成 SQL 拼装?
|
|
23
|
-
- 是否有跨层数据访问绕路?
|
|
24
|
-
|
|
25
|
-
## 回放信号
|
|
26
|
-
|
|
27
|
-
- 当数据访问方法、SQL 组织或映射策略变化时触发。
|
|
28
|
-
|
|
29
|
-
## References
|
|
30
|
-
|
|
31
|
-
- `rules/overlays/pig-cloud.md`
|
|
32
|
-
- `rules/overlays/pig-cloud/query-style.md`
|
|
@@ -1,32 +0,0 @@
|
|
|
1
|
-
# Pig Cloud 查询规则
|
|
2
|
-
|
|
3
|
-
`overlays/pig-cloud/query-style.md` 定义查询和更新写法。
|
|
4
|
-
|
|
5
|
-
## 默认做法
|
|
6
|
-
|
|
7
|
-
- 优先使用 lambda query/update。
|
|
8
|
-
- 条件表达式保持可读、可重构。
|
|
9
|
-
- 查询和更新风格保持一致,不在同模块内漂移。
|
|
10
|
-
|
|
11
|
-
## 禁区
|
|
12
|
-
|
|
13
|
-
- 不要把字段名字符串散落在业务逻辑里。
|
|
14
|
-
- 不要为了图快引入难维护的拼接式查询。
|
|
15
|
-
- 不要让查询风格和数据访问职责分离到不同层。
|
|
16
|
-
- 不要把临时统计逻辑伪装成常规查询风格。
|
|
17
|
-
|
|
18
|
-
## 检查
|
|
19
|
-
|
|
20
|
-
- 这段读写是否还能保持 lambda 风格?
|
|
21
|
-
- 条件是否容易重构和复用?
|
|
22
|
-
- 是否引入了不必要的字符串字段依赖?
|
|
23
|
-
- 是否把特殊 SQL 当成默认风格?
|
|
24
|
-
|
|
25
|
-
## 回放信号
|
|
26
|
-
|
|
27
|
-
- 当读写条件、查询方式或更新方式变化时触发。
|
|
28
|
-
|
|
29
|
-
## References
|
|
30
|
-
|
|
31
|
-
- `rules/overlays/pig-cloud.md`
|
|
32
|
-
- `rules/overlays/pig-cloud/mapper.md`
|
|
@@ -1,33 +0,0 @@
|
|
|
1
|
-
# Pig Cloud 响应规则
|
|
2
|
-
|
|
3
|
-
`overlays/pig-cloud/rest-response.md` 定义 REST 返回封装。
|
|
4
|
-
|
|
5
|
-
## 默认做法
|
|
6
|
-
|
|
7
|
-
- REST 接口默认使用 `Result<T>` 作为返回封装。
|
|
8
|
-
- 成功、失败和业务异常返回保持统一结构。
|
|
9
|
-
- 返回内容尽量稳定,避免临时拼装不同响应形状。
|
|
10
|
-
|
|
11
|
-
## 禁区
|
|
12
|
-
|
|
13
|
-
- 不要在同一仓库里混用多套响应封装。
|
|
14
|
-
- 不要让 Controller 直接暴露随意的原始对象形状。
|
|
15
|
-
- 不要为了局部方便引入不一致的错误返回格式。
|
|
16
|
-
- 不要把业务异常、HTTP 状态和封装协议混成一层规则。
|
|
17
|
-
|
|
18
|
-
## 检查
|
|
19
|
-
|
|
20
|
-
- 新增接口是否沿用了统一响应封装?
|
|
21
|
-
- 是否需要兼容旧响应结构?
|
|
22
|
-
- 是否有局部响应形状漂移风险?
|
|
23
|
-
- 是否把响应协议和异常语义混写了?
|
|
24
|
-
|
|
25
|
-
## 回放信号
|
|
26
|
-
|
|
27
|
-
- 当接口出入参、返回结构或错误包装方式发生变化时触发。
|
|
28
|
-
|
|
29
|
-
## References
|
|
30
|
-
|
|
31
|
-
- `rules/overlays/pig-cloud.md`
|
|
32
|
-
- `rules/index.md`
|
|
33
|
-
- `rules/overlays/pig-cloud/exception.md`
|
|
@@ -1,33 +0,0 @@
|
|
|
1
|
-
# Pig Cloud Service 规则
|
|
2
|
-
|
|
3
|
-
`overlays/pig-cloud/service.md` 定义 Service 层边界。
|
|
4
|
-
|
|
5
|
-
## 默认做法
|
|
6
|
-
|
|
7
|
-
- Service 负责业务编排、规则组合和事务边界。
|
|
8
|
-
- 以用例为中心组织方法,不把流程拆碎到上层。
|
|
9
|
-
- 需要落库时,由 Service 统一调度 Mapper。
|
|
10
|
-
|
|
11
|
-
## 禁区
|
|
12
|
-
|
|
13
|
-
- 不要把复杂流程放到 Controller。
|
|
14
|
-
- 不要把事务边界拆散到多个层重复声明。
|
|
15
|
-
- 不要把业务步骤写成纯透传。
|
|
16
|
-
- 不要在 Service 里输出 HTTP 响应语义。
|
|
17
|
-
|
|
18
|
-
## 检查
|
|
19
|
-
|
|
20
|
-
- 这段逻辑是否应该留在 Service?
|
|
21
|
-
- 事务和编排是否由 Service 统一掌控?
|
|
22
|
-
- 是否把业务用例拆得过碎?
|
|
23
|
-
- 是否把接口层语义带进了业务层?
|
|
24
|
-
|
|
25
|
-
## 回放信号
|
|
26
|
-
|
|
27
|
-
- 当业务流程、事务边界或编排顺序变化时触发。
|
|
28
|
-
|
|
29
|
-
## References
|
|
30
|
-
|
|
31
|
-
- `rules/overlays/pig-cloud.md`
|
|
32
|
-
- `rules/overlays/pig-cloud/layering.md`
|
|
33
|
-
- `rules/overlays/pig-cloud/transactions.md`
|
|
@@ -1,32 +0,0 @@
|
|
|
1
|
-
# Pig Cloud 事务规则
|
|
2
|
-
|
|
3
|
-
`overlays/pig-cloud/transactions.md` 定义事务边界。
|
|
4
|
-
|
|
5
|
-
## 默认做法
|
|
6
|
-
|
|
7
|
-
- 事务默认放在 Service 层。
|
|
8
|
-
- 以业务用例为单位管理事务边界。
|
|
9
|
-
- Controller 和 Mapper 不承担事务编排职责。
|
|
10
|
-
|
|
11
|
-
## 禁区
|
|
12
|
-
|
|
13
|
-
- 不要把事务放进 Controller。
|
|
14
|
-
- 不要把事务逻辑散落到 Mapper。
|
|
15
|
-
- 不要让多个事务边界互相打架。
|
|
16
|
-
- 不要把补偿逻辑当成事务替代品。
|
|
17
|
-
|
|
18
|
-
## 检查
|
|
19
|
-
|
|
20
|
-
- 这个写操作是否已经在 Service 层包住?
|
|
21
|
-
- 事务边界是否和业务用例一致?
|
|
22
|
-
- 是否存在跨层重复声明事务的情况?
|
|
23
|
-
- 失败路径是事务回滚还是业务补偿,是否说清楚了?
|
|
24
|
-
|
|
25
|
-
## 回放信号
|
|
26
|
-
|
|
27
|
-
- 当写路径、补偿逻辑或事务边界调整时触发。
|
|
28
|
-
|
|
29
|
-
## References
|
|
30
|
-
|
|
31
|
-
- `rules/overlays/pig-cloud.md`
|
|
32
|
-
- `rules/overlays/pig-cloud/service.md`
|
|
@@ -1,33 +0,0 @@
|
|
|
1
|
-
# Pig Cloud 校验规则
|
|
2
|
-
|
|
3
|
-
`overlays/pig-cloud/validation.md` 定义请求校验边界。
|
|
4
|
-
|
|
5
|
-
## 默认做法
|
|
6
|
-
|
|
7
|
-
- 写接口默认使用 `@Valid @RequestBody`。
|
|
8
|
-
- 入口层先校验,Service 不补救请求格式错误。
|
|
9
|
-
- 校验规则跟随请求 DTO,不散到业务方法里。
|
|
10
|
-
|
|
11
|
-
## 禁区
|
|
12
|
-
|
|
13
|
-
- 不要用手写解析代替标准校验。
|
|
14
|
-
- 不要把入参合法性检查下沉到 Service 再兜底。
|
|
15
|
-
- 不要让同类接口各自定义一套校验入口。
|
|
16
|
-
- 不要把校验结果包装成业务语义。
|
|
17
|
-
|
|
18
|
-
## 检查
|
|
19
|
-
|
|
20
|
-
- 校验是否在边界层完成?
|
|
21
|
-
- 是否存在跳过校验的写接口?
|
|
22
|
-
- 校验失败是否由统一错误出口处理?
|
|
23
|
-
- 是否把参数合法性和业务失败混在一起?
|
|
24
|
-
|
|
25
|
-
## 回放信号
|
|
26
|
-
|
|
27
|
-
- 当请求 DTO、写接口约束或校验注解变化时触发。
|
|
28
|
-
|
|
29
|
-
## References
|
|
30
|
-
|
|
31
|
-
- `rules/overlays/pig-cloud.md`
|
|
32
|
-
- `rules/overlays/pig-cloud/exception.md`
|
|
33
|
-
- `rules/overlays/pig-cloud/dto-vo.md`
|
|
@@ -1,25 +0,0 @@
|
|
|
1
|
-
# Product Acceptance Rules
|
|
2
|
-
|
|
3
|
-
## 默认做法
|
|
4
|
-
|
|
5
|
-
- Turn business intent into observable acceptance criteria.
|
|
6
|
-
- Make assumptions explicit when the input is incomplete.
|
|
7
|
-
- Separate happy path, edge cases, and non-goals.
|
|
8
|
-
|
|
9
|
-
## 禁区
|
|
10
|
-
|
|
11
|
-
- Do not make acceptance criteria depend on implementation details.
|
|
12
|
-
- Do not leave vague qualifiers where a testable condition is possible.
|
|
13
|
-
|
|
14
|
-
## 检查
|
|
15
|
-
|
|
16
|
-
- Can each criterion be checked?
|
|
17
|
-
- Are the boundaries and non-goals explicit?
|
|
18
|
-
|
|
19
|
-
## 回放信号
|
|
20
|
-
|
|
21
|
-
- Trigger when the request needs acceptance criteria, scope confirmation, or product sign-off support.
|
|
22
|
-
|
|
23
|
-
## References
|
|
24
|
-
|
|
25
|
-
- `product/index.md`
|
|
@@ -1,27 +0,0 @@
|
|
|
1
|
-
# Product Briefing Rules
|
|
2
|
-
|
|
3
|
-
## 默认做法
|
|
4
|
-
|
|
5
|
-
- Convert raw input into a compact, decision-ready brief.
|
|
6
|
-
- Record problem, target users, business goal, scope, non-scope, and open questions.
|
|
7
|
-
- Preserve the phrasing that downstream engineering needs.
|
|
8
|
-
|
|
9
|
-
## 禁区
|
|
10
|
-
|
|
11
|
-
- Do not write code-level solutions.
|
|
12
|
-
- Do not jump into architecture before scope is settled.
|
|
13
|
-
- Do not hide unresolved questions.
|
|
14
|
-
|
|
15
|
-
## 检查
|
|
16
|
-
|
|
17
|
-
- Is the brief short enough to scan quickly?
|
|
18
|
-
- Are the unresolved questions visible?
|
|
19
|
-
- Is the business goal separated from solution ideas?
|
|
20
|
-
|
|
21
|
-
## 回放信号
|
|
22
|
-
|
|
23
|
-
- Trigger when the input is a draft request, meeting note, or rough business idea.
|
|
24
|
-
|
|
25
|
-
## References
|
|
26
|
-
|
|
27
|
-
- `product/index.md`
|
package/rules/product/index.md
DELETED
|
@@ -1,36 +0,0 @@
|
|
|
1
|
-
# Product Rules
|
|
2
|
-
|
|
3
|
-
`product/` contains rules for product intent, scope, and requirement shaping.
|
|
4
|
-
|
|
5
|
-
## 默认做法
|
|
6
|
-
|
|
7
|
-
- Capture the business problem before solution details.
|
|
8
|
-
- Separate in-scope, out-of-scope, and open questions.
|
|
9
|
-
- Keep current project facts separate from product intent.
|
|
10
|
-
- Keep the output ready for engineering refinement, not implementation.
|
|
11
|
-
|
|
12
|
-
## 禁区
|
|
13
|
-
|
|
14
|
-
- Do not write implementation details.
|
|
15
|
-
- Do not choose technical constraints too early.
|
|
16
|
-
- Do not let product notes become code specs.
|
|
17
|
-
- Do not collapse business ambiguity into fake certainty.
|
|
18
|
-
|
|
19
|
-
## 检查
|
|
20
|
-
|
|
21
|
-
- Is the problem statement clear?
|
|
22
|
-
- Is the scope bounded?
|
|
23
|
-
- Is the output ready for the next stage?
|
|
24
|
-
- Is the business outcome measurable?
|
|
25
|
-
|
|
26
|
-
## 回放信号
|
|
27
|
-
|
|
28
|
-
- Trigger when the request is about business intent, requirements, or scope discovery.
|
|
29
|
-
|
|
30
|
-
## References
|
|
31
|
-
|
|
32
|
-
- `product/intake.md`
|
|
33
|
-
- `product/project-context.md`
|
|
34
|
-
- `product/modeling.md`
|
|
35
|
-
- `product/briefing.md`
|
|
36
|
-
- `product/acceptance.md`
|
package/rules/product/intake.md
DELETED
|
@@ -1,27 +0,0 @@
|
|
|
1
|
-
# Product Intake Rules
|
|
2
|
-
|
|
3
|
-
## 默认做法
|
|
4
|
-
|
|
5
|
-
- Capture the user need, business goal, and release context.
|
|
6
|
-
- Turn noisy input into a PRD-ready brief.
|
|
7
|
-
- Record scope, priority, acceptance outline, and open questions.
|
|
8
|
-
|
|
9
|
-
## 禁区
|
|
10
|
-
|
|
11
|
-
- Do not write implementation details.
|
|
12
|
-
- Do not pick technical solutions too early.
|
|
13
|
-
- Do not produce code-oriented specs.
|
|
14
|
-
|
|
15
|
-
## 检查
|
|
16
|
-
|
|
17
|
-
- Is the business outcome explicit?
|
|
18
|
-
- Are scope and non-scope separated?
|
|
19
|
-
- Are the follow-up questions visible?
|
|
20
|
-
|
|
21
|
-
## 回放信号
|
|
22
|
-
|
|
23
|
-
- Trigger when the input is raw business intent, meeting notes, or a draft PRD.
|
|
24
|
-
|
|
25
|
-
## References
|
|
26
|
-
|
|
27
|
-
- `product/index.md`
|
|
@@ -1,25 +0,0 @@
|
|
|
1
|
-
# Product Modeling Rules
|
|
2
|
-
|
|
3
|
-
## 默认做法
|
|
4
|
-
|
|
5
|
-
- Normalize domain concepts, terms, and entity relationships.
|
|
6
|
-
- Keep the model understandable to both product and engineering.
|
|
7
|
-
- Link terminology back to the brief.
|
|
8
|
-
|
|
9
|
-
## 禁区
|
|
10
|
-
|
|
11
|
-
- Do not redesign the business problem into a technical implementation.
|
|
12
|
-
- Do not overload the model with code details.
|
|
13
|
-
|
|
14
|
-
## 检查
|
|
15
|
-
|
|
16
|
-
- Are the core terms stable?
|
|
17
|
-
- Are the relationships clear enough for downstream design?
|
|
18
|
-
|
|
19
|
-
## 回放信号
|
|
20
|
-
|
|
21
|
-
- Trigger when the request is about domain concepts, terminology, or business object modeling.
|
|
22
|
-
|
|
23
|
-
## References
|
|
24
|
-
|
|
25
|
-
- `product/index.md`
|
|
@@ -1,29 +0,0 @@
|
|
|
1
|
-
# Project Context Rules
|
|
2
|
-
|
|
3
|
-
## 项目上下文规则
|
|
4
|
-
|
|
5
|
-
- Capture what the current project already guarantees before rewriting the requirement.
|
|
6
|
-
- Separate product intent, existing project facts, and assumptions.
|
|
7
|
-
- Prefer current repo docs, release notes, and existing behavior over memory.
|
|
8
|
-
- Record conflicts when product demand does not match current project facts.
|
|
9
|
-
|
|
10
|
-
## 禁区
|
|
11
|
-
|
|
12
|
-
- Do not turn implementation details into product requirements.
|
|
13
|
-
- Do not ignore existing project facts when they are available.
|
|
14
|
-
- Do not hide conflicts behind vague wording.
|
|
15
|
-
|
|
16
|
-
## 检查项
|
|
17
|
-
|
|
18
|
-
- Are product intent and project facts separated?
|
|
19
|
-
- Are conflicts and open questions explicit?
|
|
20
|
-
- Does the output still work for spec-refinement?
|
|
21
|
-
- Is the project context based on current evidence?
|
|
22
|
-
|
|
23
|
-
## 触发信号
|
|
24
|
-
|
|
25
|
-
- Trigger when the task needs product understanding aligned with the current project state.
|
|
26
|
-
|
|
27
|
-
## References
|
|
28
|
-
|
|
29
|
-
- `product/index.md`
|
package/rules/review/code.md
DELETED
|
@@ -1,35 +0,0 @@
|
|
|
1
|
-
# Code Review Rules
|
|
2
|
-
|
|
3
|
-
## 默认做法
|
|
4
|
-
|
|
5
|
-
- Read the diff against the current rules bundle.
|
|
6
|
-
- Report correctness, safety, maintainability, and regression risks.
|
|
7
|
-
- Keep the output actionable.
|
|
8
|
-
- Mention the exact code path or symbol that causes the finding.
|
|
9
|
-
- Prefer one finding per line of reasoning.
|
|
10
|
-
- Format each finding as: location, issue, why it matters, and a concrete fix direction.
|
|
11
|
-
- When stack overlays apply, anchor the finding to the smallest relevant stack surface.
|
|
12
|
-
- If there are no findings, say why the change is acceptable instead of hand-waving.
|
|
13
|
-
- Separate must-fix issues from optional suggestions.
|
|
14
|
-
|
|
15
|
-
## 禁区
|
|
16
|
-
|
|
17
|
-
- Do not rewrite code from review mode.
|
|
18
|
-
- Do not widen the scope beyond the submitted change.
|
|
19
|
-
- Do not mix findings with implementation patches.
|
|
20
|
-
|
|
21
|
-
## 检查
|
|
22
|
-
|
|
23
|
-
- Are the findings backed by evidence?
|
|
24
|
-
- Is each recommendation directly actionable?
|
|
25
|
-
- Would a maintainer know what to change without re-reading the whole diff?
|
|
26
|
-
- Does each finding stand on its own?
|
|
27
|
-
- Would the report still make sense if the author were unavailable?
|
|
28
|
-
|
|
29
|
-
## 回放信号
|
|
30
|
-
|
|
31
|
-
- Trigger when the request is a standard code review or PR review.
|
|
32
|
-
|
|
33
|
-
## References
|
|
34
|
-
|
|
35
|
-
- `review/index.md`
|