Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
49 changes: 49 additions & 0 deletions .github/ISSUE_TEMPLATE/bug.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
name: Bug
description: Runtime, CLI, docs, release, or workflow behavior that is wrong.
title: "bug: <short description>"
labels:
- type:bug
body:
- type: textarea
id: current
attributes:
label: Current behavior
description: What happens now?
validations:
required: true
- type: textarea
id: expected
attributes:
label: Expected behavior
description: What should happen instead?
validations:
required: true
- type: textarea
id: evidence
attributes:
label: Evidence
description: Commands, files, logs, tests, screenshots, or examples.
value: |
- <evidence>
validations:
required: true
- type: dropdown
id: area
attributes:
label: Area
options:
- storage
- vault
- tui
- agent
- docs
- security
- runtime
- release
validations:
required: true
- type: input
id: milestone
attributes:
label: Suggested milestone
placeholder: v6.1.0
5 changes: 5 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
blank_issues_enabled: false
contact_links:
- name: Security vulnerability
url: mailto:james@flyingrobots.dev
about: Do not open public issues for suspected vulnerabilities.
40 changes: 40 additions & 0 deletions .github/ISSUE_TEMPLATE/debt.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
name: Debt
description: Working behavior that needs cleanup, scale hardening, or clearer boundaries.
title: "debt: <short description>"
labels:
- type:debt
body:
- type: textarea
id: problem
attributes:
label: Problem
description: What works today but bothers us?
validations:
required: true
- type: textarea
id: risk
attributes:
label: Risk
description: What failure mode, maintenance cost, or operator cost does this create?
validations:
required: true
- type: textarea
id: proposed-shape
attributes:
label: Proposed shape
description: What direction should a future design explore?
validations:
required: true
- type: textarea
id: proof
attributes:
label: Proof needed
value: |
- <proof>
validations:
required: true
- type: input
id: design
attributes:
label: Design doc, if known
placeholder: docs/design/NNNN-slug/slug.md
85 changes: 85 additions & 0 deletions .github/ISSUE_TEMPLATE/goalpost.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,85 @@
name: Goalpost
description: Release-scale feature, invariant, or evidence packet.
title: "vX.Y.Z: <goalpost title>"
labels:
- type:goalpost
body:
- type: markdown
attributes:
value: |
Goalposts are tracked in GitHub Issues. Design docs and witnesses may
live in the repo, but this issue owns work state.
- type: input
id: release
attributes:
label: Release milestone
description: Target version milestone, for example v6.1.0.
placeholder: v6.1.0
validations:
required: true
- type: textarea
id: outcome
attributes:
label: Outcome
description: State the release-scale outcome this goalpost unlocks.
validations:
required: true
- type: textarea
id: current-truth
attributes:
label: Current truth
description: Cite repo-visible facts, commands, docs, tests, PRs, or issues.
validations:
required: true
- type: textarea
id: scope
attributes:
label: Scope
description: What is included?
value: |
- <in scope>
validations:
required: true
- type: textarea
id: out-of-scope
attributes:
label: Out of scope
description: What is explicitly excluded?
value: |
- <out of scope>
validations:
required: true
- type: textarea
id: slices
attributes:
label: Slices
description: Link child issues or list turn-sized slices until child issues exist.
value: |
- [ ] Slice 1:
- [ ] Slice 2:
validations:
required: true
- type: input
id: design
attributes:
label: Design doc
description: Link the repo design doc, or write "needed".
placeholder: docs/design/NNNN-slug/slug.md
validations:
required: true
- type: textarea
id: proof
attributes:
label: Required proof
description: Tests, fixtures, witnesses, schemas, commands, or release evidence required before closeout.
value: |
- <proof>
validations:
required: true
- type: textarea
id: release-impact
attributes:
label: Release gate impact
description: Changelog, docs, package surface, migration posture, or release evidence impact.
validations:
required: true
27 changes: 27 additions & 0 deletions .github/ISSUE_TEMPLATE/idea.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
name: Idea
description: Raw opportunity that is not yet committed work.
title: "idea: <short description>"
labels:
- type:idea
body:
- type: textarea
id: opportunity
attributes:
label: Opportunity
description: What could become valuable?
validations:
required: true
- type: textarea
id: why-not-now
attributes:
label: Why not now?
description: What blocks this from becoming tracked work?
validations:
required: true
- type: textarea
id: promotion
attributes:
label: Promotion criteria
description: What would make this ready for a goalpost, slice, bug, or debt issue?
validations:
required: true
55 changes: 55 additions & 0 deletions .github/ISSUE_TEMPLATE/slice.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
name: Slice
description: Turn-sized work under a goalpost.
title: "<goalpost>: <slice title>"
labels:
- type:slice
body:
- type: input
id: parent
attributes:
label: Parent goalpost
description: Link the parent goalpost issue.
placeholder: "#123"
validations:
required: true
- type: textarea
id: work
attributes:
label: Smallest testable work
description: Define one focused unit of work.
validations:
required: true
- type: textarea
id: red-test
attributes:
label: RED test
description: Name the first failing test or witness this slice should create.
validations:
required: true
- type: textarea
id: expected-proof
attributes:
label: Expected proof
description: What proves this slice is done?
value: |
- <proof>
validations:
required: true
- type: textarea
id: validation
attributes:
label: Validation command
value: |
```bash
npx eslint .
npm test
```
validations:
required: true
- type: textarea
id: closeout
attributes:
label: Closeout condition
description: What must be true before this issue closes?
validations:
required: true
22 changes: 22 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
## Linked Issue

- Refs #
- Closes # only when this PR completes the issue.

## Design / Proof

- Design doc:
- Witness or focused proof:

## Validation

```bash
npx eslint .
npm test
```

## Release Impact

- [ ] Changelog updated, if release behavior changed.
- [ ] Public docs updated, if user-facing behavior changed.
- [ ] Issue labels/milestone reflect final disposition.
1 change: 0 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@ coverage/
.obsidian/
.codex/
lastchat.txt
AGENTS.md
EDITORS-REPORT
EDITORS-REPORT.*
CODE-EVAL.md
Expand Down
65 changes: 65 additions & 0 deletions AGENTS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
# AGENTS

This guide is for AI agents and human operators recovering context in the
`git-cas` repository.

## Git Rules

- **NEVER** amend commits.
- **NEVER** rebase or force-push.
- **NEVER** push to `main` without explicit permission.
- Always use standard commits and regular pushes.

## Documentation & Planning Map

Do not audit the repository by recursively walking the filesystem. Follow the
authoritative manifests:

### 1. The Entrance

- **`README.md`**: Public front door, core value prop, and quick start.
- **`GUIDE.md`**: Orientation and productive-fast path.
- **`docs/WALKTHROUGH.md`**: Long-form manual and examples.

### 2. The Bedrock

- **`ARCHITECTURE.md`**: The authoritative structural reference (Facade,
Domain, Ports).
- **`VISION.md`**: Core tenets and project identity.
- **`WORKFLOW.md`** and **`docs/method/process.md`**: Repo work doctrine.

### 3. The Direction

- **`BEARING.md`**: Current execution gravity and active tensions.
- **GitHub Issues and Milestones**: Active source of truth for pending work.
- **`ROADMAP.md`**: Signpost to the GitHub release tracker.
- **`docs/design/`**: Durable design contracts and proof plans.

### 4. The Proof

- **`CHANGELOG.md`**: Historical truth of merged behavior.
- **`STATUS.md`**: Compact snapshot of release and runtime truth.

## Context Recovery Protocol

When starting a new session or recovering from context loss:

1. **Read `BEARING.md`** to find the current execution gravity.
2. **Read `WORKFLOW.md` and `docs/method/process.md`** to understand the work
doctrine.
3. **Check GitHub Issues and Milestones** for tracked work.
4. **Check `ROADMAP.md`** for release-train orientation.
5. **Check `git log -n 5` and `git status`** to verify the current branch state.

## End of Turn Checklist

After altering files:

1. **Verify Truth**: Ensure documentation is updated if behavior or structure
changed.
2. **Log Debt**: Add follow-on work as GitHub Issues.
3. **Commit**: Use focused, conventional commit messages.
4. **Validate**: Run `npm test` and `npx eslint .`.

---
**The goal is inevitably. Every feature is defined by its tests.**
Loading
Loading