hackclub/burrow
1
0
Fork 0
Code Pull requests Releases Packages Activity Actions
burrow/evolution
History
Exact
Conrad Kramer 97c569fb35
Some checks failed
Build Rust / Cargo Test (push) Successful in 3m50s
Details
Build Site / Next.js Build (push) Failing after 2s
Details
Lint Governance / BEP Metadata (push) Successful in 0s
Details
Align GTK app with Apple home surface 
Add the GTK home screen, local account store, daemon gRPC wrapper, and embedded Linux daemon startup path so the Linux app follows the Apple client UX and daemon boundary.

Document the GTK parity expectations and update the daemon IPC and Tailnet BEPs with the cross-platform client model.
2026-05-03 17:36:55 -07:00
..
proposals Align GTK app with Apple home surface 2026-05-03 17:36:55 -07:00
README.md Add governance and identity registry scaffolding 2026-04-03 01:36:10 -07:00

README.md

Burrow Evolution

Burrow Evolution Proposals (BEPs) are the repository's durable design record for protocol work, control-plane changes, forge infrastructure, and operational policy.

Goals

  1. Capture intent before implementation outruns the architecture.
  2. Give contributors and agents enough context to work safely without re-discovering prior decisions.
  3. Tie ambitious work to concrete validation, rollout, and rollback criteria.

When a BEP is required

Open a BEP for:

  • new transports or protocol families
  • control-plane and identity changes
  • deployment, forge, runner, or secrets changes
  • data model migrations
  • user-visible behavior that changes security or routing semantics

Small bug fixes and isolated refactors do not need a BEP unless they materially change one of the areas above.

Lifecycle

  1. Pitch Capture the problem and why it matters now.
  2. Draft Copy evolution/proposals/0000-template.md to evolution/proposals/BEP-XXXX-short-slug.md.
  3. Review Collect feedback, tighten the design, and document unresolved concerns.
  4. Decision Mark the proposal Accepted, Rejected, or Returned for Revision.
  5. Implementation Link code changes, tests, and rollout evidence.
  6. Supersession Keep historical proposals in-tree and point forward to the replacing BEP.

Status Values

  • Pitch
  • Draft
  • In Review
  • Accepted
  • Implemented
  • Rejected
  • Returned for Revision
  • Superseded
  • Archived

Layout

evolution/
  README.md
  proposals/
    0000-template.md
    BEP-0001-...

Use ASCII Markdown. Keep metadata at the top of each proposal so tooling and future agents can parse it quickly.

BEP Helper

Use the bep helper under Scripts/ to browse or list proposals:

  • Scripts/bep opens a quick browser for evolution/.
  • Scripts/bep list --status Draft lists proposals by status.
  • Scripts/bep open BEP-0005 opens a proposal in $EDITOR.

Validate proposal metadata with:

python3 Scripts/check-bep-metadata.py