Move to AGENTS.md as default

This commit is contained in:
franzap
2026-02-05 15:35:56 -03:00
parent 36e3677b80
commit 5efd80cacf
2 changed files with 57 additions and 67 deletions
+57 -6
View File
@@ -1,12 +1,22 @@
# AI Agents # AI Agents
Start here: [CONTEXT.md](CONTEXT.md) This document is the entry point for AI assistants.
All behavioral authority lives in the project spec, not here.
If anything in this file conflicts with files under `spec/guidelines/`,
this file is wrong.
## What This Repository Is
Zapstore is a local-first, Nostr-native app store for Android.
It discovers, downloads, verifies, and installs APKs signed by developers the user trusts.
Users can support developers directly via Lightning zaps.
## Quick Reference ## Quick Reference
| What | Where | | What | Where |
|------|-------| |------|-------|
| Project overview | `CONTEXT.md` |
| Architecture & patterns | `spec/guidelines/ARCHITECTURE.md` | | Architecture & patterns | `spec/guidelines/ARCHITECTURE.md` |
| Non-negotiable rules | `spec/guidelines/INVARIANTS.md` | | Non-negotiable rules | `spec/guidelines/INVARIANTS.md` |
| Quality standards | `spec/guidelines/QUALITY_BAR.md` | | Quality standards | `spec/guidelines/QUALITY_BAR.md` |
@@ -14,8 +24,49 @@ Start here: [CONTEXT.md](CONTEXT.md)
| Feature specs | `spec/features/` | | Feature specs | `spec/features/` |
| Active work | `work/` | | Active work | `work/` |
## Rules ## Project Spec Structure
1. Read `CONTEXT.md` first spec/
2. Never modify files in `spec/guidelines/` guidelines/ # Permanent rules (human-owned, never AI-modified)
3. If a spec is unclear, report it—do not guess ARCHITECTURE.md # Package boundaries, dependencies, key patterns
INVARIANTS.md # Non-negotiable behavioral guarantees
QUALITY_BAR.md # Standards, when to create specs
VISION.md # Product goals and non-goals
features/ # Feature specs (behavioral contracts)
_TEMPLATE.md # Template with example
FEAT-001-*.md # Actual feature specs
work/ # Active work packets (temporary, delete after merge)
_TEMPLATE.md # Template with example
WORK-001-*.md # Actual work packets
## How to Work
1. Before implementing, check `spec/features/` for a relevant feature spec
2. For non-trivial work, create a work packet in `work/`
3. Every code change must trace to a task in the work packet
4. If a spec is unclear or incorrect, report a Spec Issue—do not guess
See `spec/guidelines/QUALITY_BAR.md` for what qualifies as "non-trivial."
## File Ownership
**Never modify** files in `spec/guidelines/`.
If a guideline seems wrong or incomplete, report it as a Spec Issue.
| Path | Owner | AI May Modify |
|------|-------|---------------|
| `spec/guidelines/*` | Human | No |
| `spec/features/*` | Human | No (unless explicitly asked) |
| `work/*.md` | AI | Yes |
| `lib/**` | Shared | Yes |
| `test/**` | Shared | Yes |
| `AGENTS.md` | Human | No |
## Working Rules
- Prefer small, localized changes. Avoid unrelated refactors.
- After dependency changes, run: `fvm flutter pub get`
- Fix any analyze/lint errors introduced by your changes.
- Assume Android as default target unless instructed otherwise.
-61
View File
@@ -1,61 +0,0 @@
# Zapstore — Project Context
This document is the entry point for AI assistants.
All behavioral authority lives in the project spec, not here.
If anything in this file conflicts with files under `spec/guidelines/`,
this file is wrong.
## What This Repository Is
Zapstore is a local-first, Nostr-native app store for Android.
It discovers, downloads, verifies, and installs APKs signed by developers the user trusts.
Users can support developers directly via Lightning zaps.
## Project Spec Structure
spec/
guidelines/ # Permanent rules (human-owned, never AI-modified)
ARCHITECTURE.md # Package boundaries, dependencies, key patterns
INVARIANTS.md # Non-negotiable behavioral guarantees
QUALITY_BAR.md # Standards, when to create specs
VISION.md # Product goals and non-goals
features/ # Feature specs (behavioral contracts)
_TEMPLATE.md # Template with example
FEAT-001-*.md # Actual feature specs
work/ # Active work packets (temporary, delete after merge)
_TEMPLATE.md # Template with example
WORK-001-*.md # Actual work packets
## How to Work
1. Before implementing, check `spec/features/` for a relevant feature spec
2. For non-trivial work, create a work packet in `work/`
3. Every code change must trace to a task in the work packet
4. If a spec is unclear or incorrect, report a Spec Issue—do not guess
See `spec/guidelines/QUALITY_BAR.md` for what qualifies as "non-trivial."
## File Ownership
**Never modify** files in `spec/guidelines/`.
If a guideline seems wrong or incomplete, report it as a Spec Issue.
| Path | Owner | AI May Modify |
|------|-------|---------------|
| `spec/guidelines/*` | Human | No |
| `spec/features/*` | Human | No (unless explicitly asked) |
| `work/*.md` | AI | Yes |
| `lib/**` | Shared | Yes |
| `test/**` | Shared | Yes |
| `CONTEXT.md` | Human | No |
## Working Rules
- Prefer small, localized changes. Avoid unrelated refactors.
- After dependency changes, run: `fvm flutter pub get`
- Fix any analyze/lint errors introduced by your changes.
- Assume Android as default target unless instructed otherwise.