Skip to content

users.md

Latest commit

 

History

History
46 lines (34 loc) · 1.14 KB

users.md

File metadata and controls

46 lines (34 loc) · 1.14 KB

Workflow User Guide

This guide explains how the repository workflow benefits maintainers and users.

User Benefits

The branch-plan-doc workflow improves:

  • clarity of changes
  • predictability of behavior
  • security review quality
  • trust in AI-assisted updates

What To Expect In Changes

High-quality changes in this repository should include:

  • a scoped feature branch
  • a plan file under .agents/plans/
  • synchronized docs in docs/
  • updated diagrams when architecture/workflow changes
flowchart TD
  A["Scoped Workflow"] --> B["Cleaner Changes"]
  B --> C["Easier Review"]
  C --> D["Fewer Regressions"]
  D --> E["Higher Trust"]
Loading

Quick Validation Path

  1. Check the matching baseline file:
    • Codex workflows: AGENTS.md
    • Claude CLI workflows: CLAUDE.md
  2. Open relevant feature docs under docs/<feature>/.
  3. Verify matching diagrams in docs/mermaid/.
  4. Confirm docs and implementation were updated together.

Related