Adopt policy provenance and documentation guidance
This commit is contained in:
@@ -10,15 +10,31 @@ uses ConfigKit v0.4.1; keep Scriptorium's schema and source selection local.
|
||||
|
||||
Before recommending, planning, or implementing work:
|
||||
|
||||
1. read the [agent policy](policy/agents.md);
|
||||
2. inspect the working tree and preserve unrelated changes;
|
||||
3. read the [architecture policy](policy/architecture.md);
|
||||
4. follow the task-specific contracts and internal documents below; and
|
||||
5. inspect the relevant implementation and tests before changing them.
|
||||
1. inspect the working tree and preserve unrelated changes;
|
||||
2. use the policy and task-specific reading guides below; and
|
||||
3. inspect the relevant implementation and tests before changing them.
|
||||
|
||||
Also read the [documentation policy](policy/documentation.md) before changing
|
||||
documentation and the [testing policy](policy/testing.md) before changing
|
||||
tests.
|
||||
## Policy Reading Guide
|
||||
|
||||
| Policy | Read before… |
|
||||
| --- | --- |
|
||||
| [Policy set provenance](policy/meta.md) | Adopting policies, checking upstream revisions, or updating the adopted policy set. |
|
||||
| [Agents](policy/agents.md) | Recommending, planning, or implementing repository changes. |
|
||||
| [Architecture](policy/architecture.md) | Planning or changing application code or its structure. |
|
||||
| [Testing](policy/testing.md) | Selecting validation for code changes, or adding, changing, removing, or evaluating tests. |
|
||||
| [Documentation](policy/documentation.md) | Writing, revising, or reorganizing documentation. |
|
||||
| [OSS](policy/oss.md) | Adding or updating dependencies or incorporated third-party material, or changing licensing or attribution. |
|
||||
| [Release](policy/release.md) | Preparing or publishing a release, changing release procedures, or making versioning and compatibility decisions. |
|
||||
|
||||
- Read applicable policies before making decisions they govern; multiple policies
|
||||
may apply.
|
||||
- Select policies using the task triggers above. Follow cross-references to
|
||||
relevant sections when needed to resolve a concrete question.
|
||||
- Reuse policies already available in context; reread when changed or no longer
|
||||
available.
|
||||
- Expand reading when the task's scope expands.
|
||||
- When revising a policy itself, read that policy and any provisions elsewhere
|
||||
affected by the revision.
|
||||
|
||||
## Task-Specific Reading Guide
|
||||
|
||||
|
||||
Reference in New Issue
Block a user