ai-policy-pack-cli 0.1.3 → 0.1.4
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/package.json +1 -1
- package/presets/anhtdq/policy.yml +15 -0
package/package.json
CHANGED
|
@@ -63,6 +63,16 @@ guidelineMarkdown: |
|
|
|
63
63
|
|
|
64
64
|
---
|
|
65
65
|
|
|
66
|
+
## 5. Documentation Currency Policy
|
|
67
|
+
|
|
68
|
+
- Use `README.md` as the primary module-context document format; keep `AGENTS.md` focused on AI workflow/policy at repository root.
|
|
69
|
+
- Update module `README.md` only when behavior or contracts changed (API/DTO, business flow, schema/migration, module structure, or reusable patterns), not for trivial refactors.
|
|
70
|
+
- For tasks that trigger doc updates, refresh outdated sections and remove stale context in the same task before marking work complete.
|
|
71
|
+
- During pre-implementation, read the nearest module `README.md` to minimize broad code scanning and reduce context usage.
|
|
72
|
+
- Before declaring task completion, report whether docs were updated or intentionally skipped.
|
|
73
|
+
|
|
74
|
+
---
|
|
75
|
+
|
|
66
76
|
**These guidelines are working if:** fewer unnecessary changes in diffs, fewer rewrites due to overcomplication, and clarifying questions come before implementation rather than after mistakes.
|
|
67
77
|
globalRules:
|
|
68
78
|
- Before implementing, state assumptions explicitly. If uncertain, ask instead of guessing.
|
|
@@ -85,6 +95,11 @@ globalRules:
|
|
|
85
95
|
- For refactors, verify behavior before and after with stable checks.
|
|
86
96
|
- For multi-step work, provide a short step plan with explicit verification at each step.
|
|
87
97
|
- Do not claim completion until verification actually passes.
|
|
98
|
+
- Use README.md as the primary module-context document format and keep AGENTS.md focused on repository-level AI workflow policy.
|
|
99
|
+
- Update module README.md when behavior/contracts change; skip doc edits for trivial refactors.
|
|
100
|
+
- If docs are required, refresh stale sections in the same task before completion.
|
|
101
|
+
- Read the nearest module README.md before implementation to reduce unnecessary broad scanning.
|
|
102
|
+
- Before closing a task, explicitly report whether docs were updated or intentionally skipped.
|
|
88
103
|
fileRules:
|
|
89
104
|
- name: universal-code-rules
|
|
90
105
|
patterns:
|