eric/policy
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update the Documentation Policy to incorporate the updated Agent Policy and Release Policy

Browse Source
This commit is contained in:
Eric Rakestraw
2026-09-23 08:31:09 -05:00
parent cd7b7c9101
commit b3510393ca
3 changed files with 6 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/policy/agents.md
View File

@@ -2,7 +2,7 @@
**Base Policy Version:** 1.0
**Last Updated**: 2026-09-06
**Last Updated**: 2026-09-23
## Base Policy Template

5
docs/policy/documentation.md
View File

@@ -1,8 +1,8 @@
# Documentation Policy
**Base Policy Version:** 1.0
**Base Policy Version:** 1.1
**Last Updated**: 2026-09-06
**Last Updated**: 2026-09-23
## Base Policy Template
@@ -73,6 +73,7 @@ secret values.
| Product orientation and minimal end-to-end quickstart | `README.md` | What this application is, why it is useful, one shortest successful invocation, and links onward. | Complete command reference, configuration reference, operational procedures, implementation detail. |
| Contributor entry point | `docs/development.md` | Task-oriented reading guide, minimal contributor orientation, baseline validation commands, and links to canonical docs. | Package inventory, architecture rules, subsystem behavior, detailed change recipes. |
| Application architecture policy | `docs/policy/architecture.md` | System shape, normative ownership, dependency direction, architectural boundaries, invariants, safety properties, and non-goals. | Concrete package inventory, implementation mechanics, contributor procedures, decision history, future work. |
| Agent policy | `docs/policy/agents.md` | Implementation discipline for coding agents, including proportionality, idiomatic simplicity, and rules against inventing requirements, restrictions, guarantees, or repository policy. | Application contracts, architecture, testing policy, and contributor procedures. |
| Documentation policy | `docs/policy/documentation.md` | Documentation ownership, audience boundaries, maintenance rules, and ADR/document lifecycle. | Application architecture or product behavior. |
| Testing policy | `docs/policy/testing.md` | Test philosophy, risk-based sufficiency, test boundaries, doubles, coverage guidance, regression-test policy, and criteria for adding, rewriting, or deleting tests. | Subsystem behavior, application contracts, subsystem-specific test inventories, and implementation plans. |
| Release policy | `docs/policy/release.md` | Versioning and compatibility rules, release integrity and immutability requirements, release-documentation policy, required gates, publication controls, verification requirements, and exception policy. | Repository-specific commands, product installation guidance, CLI version semantics, historical release summaries, and CI implementation detail. |

4
docs/policy/release.md
View File

@@ -1,8 +1,8 @@
# Release Policy
**Base Policy Version:** 0.1.0
**Base Policy Version:** 1.0
**Last Updated**: 2026-09-06
**Last Updated**: 2026-09-23
## Base Policy Template