Skip to content

Map contributors and agents to canonical process and design documents #2681

Open

Description

@codeforester

Problem

The accepted Base governance design and implementation plan identify package 16b as a required deliverable. This issue translates that package into a reviewed, bounded issue/PR train; it does not authorize implementation before the issue reaches Ready.

Expected behavior

Add METHOD.md and update AGENTS.md as concise maps to canonical issue/PR process, ADR and decision records, area designs, contracts, user/reference docs and security rules. Do not copy the content of those canonical documents into another instruction file.

Scope and non-goals

Scope: Add METHOD.md and update AGENTS.md as concise maps to canonical issue/PR process, ADR and decision records, area designs, contracts, user/reference docs and security rules. Do not copy the content of those canonical documents into another instruction file.

Non-goals: Do not silently expand scope, activate unreviewed policy, mirror issue fields onto PRs, grant agents merge/release authority, or make changes outside the named affected areas. Any new product decision or materially new work gets a separate issue and decision record.

Affected areas

Impact and evidence

  1. Product intent: Implements only the accepted governance design and plan; any product-requirement change must be filed separately.
  2. Architecture and contracts: Destination is the package-specific section of the merged governance design/implementation plan plus the affected canonical contract named above.
  3. User guidance: The issue identifies likely guidance paths; the implementation PR must name updated user/FAQ/README paths or give a change-specific reason why none is affected.
  4. CLI/API and reference: The affected-area list determines whether CLI/API/reference docs change; the implementation PR must cite the exact reference path or justify no impact.
  5. Operations and safety: No privileged automation or merge authority is implied; the PR must list operational/security effects and any rollback.
  6. Validation and testing: The issue lists the planned tests; the PR must report executed validation and explain any unavailable test.
  7. Examples and downstream use: The implementation PR must identify affected examples/consumers or give evidence that this change has no downstream surface.
  8. Governance and contributor process: This package changes or preserves the contributor/governance contract as described in Scope; links must point to the canonical rules.
  9. Decision records: No new decision is accepted by this issue; any durable deviation requires a proposed decision record and explicit maintainer acceptance.
  10. Release notes: The PR must include a user-facing release-note line or a reasoned none; this issue does not pre-decide that disposition.

These are issue-stage dispositions to refine during Triage. Before Ready, every category must have its exact destination or evidence-based no-impact reason; the PR repeats the ten-category evidence for actual changes.

Open questions

  • None known. If implementation exposes an unresolved contract, return this issue to Triage and record the decision before implementation continues.

Plan

  • S1: One focused PR for this issue. Use Fixes #N only if no additional slice is needed; if the maintainer approves multiple PRs, name each S1…Sn here before the first is opened and use Part of #N.
  • Dependencies: the P1 issue
  • Acceptance criteria:
  • METHOD.md maps each lifecycle step to its canonical source and owner.
  • AGENTS.md gives concise behavioral constraints and links to canonical process/decision/design docs.
  • No duplicated policy paragraphs or dead links remain.
  • Agent instructions include the accepted maintainer-only override and merge boundaries.
  • Validation:
  • Check all referenced paths and anchors; verify cited documents exist.
  • Review the map using a fresh-session task to locate issue, PR, decision and area guidance.
  • Run docs link tests and git diff --check.
  • Risks and rollback: A map can become stale after renames; keep it link-only and covered by link checks.
  • Decision impact: No decision is accepted merely by implementing the issue. Record the relevant accepted decision/ADR and file a superseding record if the maintainer approves a change.

Activity

  1. self-assigned this
    on Nov 10, 2026
  2. added this to the v1.11.0 milestone on Nov 11, 2026
  3. codeforester commented on Nov 11, 2026

    @codeforester
    CollaboratorAuthor

    Pre-Triage review against the accepted plan (#2664, tracker #2665)

    1. Keep the .ai-context/ pointers for now. AGENTS.md (L66–70) and .github/workflows/skills.yml:104 send agents to .ai-context/. Those pointers stay until Remove tracked AI context files from the Base repository after replacement release #2688, because the tracked context must be maintained until the replacement ships. METHOD.md should link to both, not replace them yet.
    2. METHOD.md location. Say whether it goes at the repo root or under docs/governance/; the design doesn't fix it.

    Dependencies text. Replace the P1 issue with #2666. The native blocked-by links are already correct; the body is what a reviewer reads.

    Contract text. The Impact, Scope and Open questions sections are still the shared template text. The Impact section is identical in 24 of #2666–#2690, and Scope repeats Expected behavior. That's fine in Backlog. Before Ready, replace each with this issue's own dispositions.

    Claude Code (Opus 5.5), reviewing from Ramesh's account at his request. This review comes before Triage, so it is not an issue-loop round.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

documentationDocumentation improvements

Type

Projects

  • Status
    Backlog

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions