Skip to content

chore: governance templates + ARCHITECTURE.md + Phase 3 API docs#27

Merged
AVADSA25 merged 1 commit intomainfrom
chore/governance-templates
May 3, 2026
Merged

chore: governance templates + ARCHITECTURE.md + Phase 3 API docs#27
AVADSA25 merged 1 commit intomainfrom
chore/governance-templates

Conversation

@AVADSA25
Copy link
Copy Markdown
Owner

@AVADSA25 AVADSA25 commented May 3, 2026

Summary

External review (Copilot, 2026-05-03) flagged 6 maintenance/distribution items. This PR addresses the 4 that I can do "from my end" without user-side build work. The remaining 2 (Homebrew/PyPI packaging, additional CI checks) need a real packaging push and are deferred.

What this ships

New files

Path Lines Purpose
.github/ISSUE_TEMPLATE/bug_report.yml 91 Structured bug report — PM2 service dropdown, audit-log paste, kill-switch reminder
.github/ISSUE_TEMPLATE/feature_request.yml 64 Feature template — category, privacy-alignment, scope guess
.github/ISSUE_TEMPLATE/config.yml 8 Disables blank issues; routes Q&A to Discussions, enterprise to avadigital.ai
.github/PULL_REQUEST_TEMPLATE.md 52 TDD-aligned checklist matching Phase 1/2/3 review pattern (audit pairing, kill switches, self-review)
docs/ARCHITECTURE.md 317 4 Mermaid diagrams: PM2 process topology, module relationships, skill execution paths, Phase 3 sequence

Modified

Path Change
docs/API.md +109 lines — Phase 3 autonomous-agents section. 13 endpoints documented with curl examples + body shapes (POST /api/agents, /approve, /reject, /revise, /abort, /pause, /resume, /grant, /extend_budget, /messages, /silence, GET /api/agents, /api/agents/{id}, /api/agent_global_grants)

Repo-side (already applied)

  • GitHub Discussions enabled via gh api PATCH (response: "has_discussions": true)

Maps to Copilot review

Copilot recommendation Status
Add CONTRIBUTING.md + link in README Already exists (83 lines), already linked in README §Contributing
Set up issue templates ✅ This PR (bug + feature + config)
Document API surface ✅ This PR (docs/API.md Phase 3 section + existing pre-Phase-3 sections)
Enable GitHub Discussions ✅ Done (gh API call)
Add architecture diagram ✅ This PR (docs/ARCHITECTURE.md with 4 Mermaid diagrams)
Create GitHub Releases Pending — will tag v3.0.0 after PR #26 + this PR merge
Homebrew / PyPI packaging Deferred — bigger work, separate PR
More granular labels / good-first-issue Deferred — needs a labeling pass

Test plan

  • Pure docs/governance — no code changes, no test impact
  • Existing CONTRIBUTING.md untouched
  • CI workflow (.github/workflows/ci.yml) untouched
  • Post-merge: GitHub UI shows new issue templates when clicking "New issue"
  • Post-merge: PR template auto-populates on next PR creation
  • Post-merge: Discussions tab visible on repo

🤖 Generated with Claude Code

…ence

Bundles the easy GitHub-side governance items recommended by an external
review (Copilot repo audit, 2026-05-03):

NEW
- .github/ISSUE_TEMPLATE/bug_report.yml — structured bug template with
  PM2-service dropdown, audit-log paste, kill-switch reminder
- .github/ISSUE_TEMPLATE/feature_request.yml — feature template with
  category dropdown + privacy-alignment checkboxes (local-first)
- .github/ISSUE_TEMPLATE/config.yml — disables blank issues, links to
  Discussions for Q&A and avadigital.ai for enterprise
- .github/PULL_REQUEST_TEMPLATE.md — TDD-aligned checklist matching
  the Phase 1+2+3 review patterns (audit pairing, kill switches,
  out-of-scope, self-review)
- docs/ARCHITECTURE.md — process topology + module relationships +
  skill execution paths + Phase 3 sequence diagram (4 Mermaid
  diagrams). Maps PM2 services to Phase 1/2/3 layers with state
  storage explicitly drawn

MODIFIED
- docs/API.md — added Phase 3 autonomous-agents section between the
  pre-Phase-3 Crews and Schedules sections. Documents 13 new endpoints
  (/api/agents create/list/detail/approve/reject/revise +
  abort/pause/resume/grant/extend_budget +
  /api/agents/{id}/messages + /silence + /api/agent_global_grants
  GET/POST/DELETE) with curl examples + body shapes + status flow
  references

Repo-side change (already applied via gh API):
- GitHub Discussions enabled on AVADSA25/codec

Out of scope (deferred — not "easy from my end"):
- Homebrew formula / PyPI / installers (real packaging work)
- Lint/format CI (existing ci.yml is fine for now)
- Architecture deep-dive per module (covered by per-Phase docs)
- API spec auto-generation from FastAPI (manual is fine while surface
  is small)
@AVADSA25 AVADSA25 merged commit 78deb63 into main May 3, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants