chore(task): archive 00-bootstrap-guidelines
This commit is contained in:
qzl
@@ -0,0 +1,10 @@
|
||||
{"file": ".opencode/commands/trellis/finish-work.md", "reason": "Finish work checklist"}
|
||||
{"file": ".opencode/commands/trellis/check-backend.md", "reason": "Backend check spec"}
|
||||
{"file": "backend/AGENTS.md", "reason": "Backend mandatory development rules"}
|
||||
{"file": "AGENTS.md", "reason": "Project-level routing and constraints"}
|
||||
{"file": "backend/src/core/http/errors.py", "reason": "Canonical API error class and payload pattern"}
|
||||
{"file": "backend/src/core/logging/config.py", "reason": "Structured logging conventions"}
|
||||
{"file": "backend/src/v1/schedule_items/service.py", "reason": "Service and transaction handling patterns"}
|
||||
{"file": "backend/src/core/db/base_repository.py", "reason": "Repository and soft-delete query conventions"}
|
||||
{"file": "docs/protocols/common/http-error-codes.md", "reason": "Protocol-level error code registry"}
|
||||
{"file": "pyproject.toml", "reason": "Pytest structure and marker conventions"}
|
||||
@@ -0,0 +1 @@
|
||||
{"file": ".opencode/commands/trellis/check-backend.md", "reason": "Backend check spec"}
|
||||
@@ -0,0 +1,10 @@
|
||||
{"file": ".trellis/workflow.md", "reason": "Project workflow and conventions"}
|
||||
{"file": ".trellis/spec/backend/index.md", "reason": "Backend development guide"}
|
||||
{"file": "backend/AGENTS.md", "reason": "Backend mandatory development rules"}
|
||||
{"file": "AGENTS.md", "reason": "Project-level routing and constraints"}
|
||||
{"file": "backend/src/core/http/errors.py", "reason": "Canonical API error class and payload pattern"}
|
||||
{"file": "backend/src/core/logging/config.py", "reason": "Structured logging conventions"}
|
||||
{"file": "backend/src/v1/schedule_items/service.py", "reason": "Service and transaction handling patterns"}
|
||||
{"file": "backend/src/core/db/base_repository.py", "reason": "Repository and soft-delete query conventions"}
|
||||
{"file": "docs/protocols/common/http-error-codes.md", "reason": "Protocol-level error code registry"}
|
||||
{"file": "pyproject.toml", "reason": "Pytest structure and marker conventions"}
|
||||
@@ -0,0 +1,101 @@
|
||||
# Bootstrap: Fill Project Development Guidelines
|
||||
|
||||
## Purpose
|
||||
|
||||
Welcome to Trellis! This is your first task.
|
||||
|
||||
AI agents use `.trellis/spec/` to understand YOUR project's coding conventions.
|
||||
**Empty templates = AI writes generic code that doesn't match your project style.**
|
||||
|
||||
Filling these guidelines is a one-time setup that pays off for every future AI session.
|
||||
|
||||
---
|
||||
|
||||
## Your Task
|
||||
|
||||
Fill in the guideline files based on your **existing codebase**.
|
||||
|
||||
|
||||
### Backend Guidelines
|
||||
|
||||
| File | What to Document |
|
||||
|------|------------------|
|
||||
| `.trellis/spec/backend/directory-structure.md` | Where different file types go (routes, services, utils) |
|
||||
| `.trellis/spec/backend/database-guidelines.md` | ORM, migrations, query patterns, naming conventions |
|
||||
| `.trellis/spec/backend/error-handling.md` | How errors are caught, logged, and returned |
|
||||
| `.trellis/spec/backend/logging-guidelines.md` | Log levels, format, what to log |
|
||||
| `.trellis/spec/backend/quality-guidelines.md` | Code review standards, testing requirements |
|
||||
|
||||
|
||||
### Thinking Guides (Optional)
|
||||
|
||||
The `.trellis/spec/guides/` directory contains thinking guides that are already
|
||||
filled with general best practices. You can customize them for your project if needed.
|
||||
|
||||
---
|
||||
|
||||
## How to Fill Guidelines
|
||||
|
||||
### Step 0: Import from Existing Specs (Recommended)
|
||||
|
||||
Many projects already have coding conventions documented. **Check these first** before writing from scratch:
|
||||
|
||||
| File / Directory | Tool |
|
||||
|------|------|
|
||||
| `CLAUDE.md` / `CLAUDE.local.md` | Claude Code |
|
||||
| `AGENTS.md` | Claude Code |
|
||||
| `.cursorrules` | Cursor |
|
||||
| `.cursor/rules/*.mdc` | Cursor (rules directory) |
|
||||
| `.windsurfrules` | Windsurf |
|
||||
| `.clinerules` | Cline |
|
||||
| `.roomodes` | Roo Code |
|
||||
| `.github/copilot-instructions.md` | GitHub Copilot |
|
||||
| `.vscode/settings.json` → `github.copilot.chat.codeGeneration.instructions` | VS Code Copilot |
|
||||
| `CONVENTIONS.md` / `.aider.conf.yml` | aider |
|
||||
| `CONTRIBUTING.md` | General project conventions |
|
||||
| `.editorconfig` | Editor formatting rules |
|
||||
|
||||
If any of these exist, read them first and extract the relevant coding conventions into the corresponding `.trellis/spec/` files. This saves significant effort compared to writing everything from scratch.
|
||||
|
||||
### Step 1: Analyze the Codebase
|
||||
|
||||
Ask AI to help discover patterns from actual code:
|
||||
|
||||
- "Read all existing config files (CLAUDE.md, .cursorrules, etc.) and extract coding conventions into .trellis/spec/"
|
||||
- "Analyze my codebase and document the patterns you see"
|
||||
- "Find error handling / component / API patterns and document them"
|
||||
|
||||
### Step 2: Document Reality, Not Ideals
|
||||
|
||||
Write what your codebase **actually does**, not what you wish it did.
|
||||
AI needs to match existing patterns, not introduce new ones.
|
||||
|
||||
- **Look at existing code** - Find 2-3 examples of each pattern
|
||||
- **Include file paths** - Reference real files as examples
|
||||
- **List anti-patterns** - What does your team avoid?
|
||||
|
||||
---
|
||||
|
||||
## Completion Checklist
|
||||
|
||||
- [ ] Guidelines filled for your project type
|
||||
- [ ] At least 2-3 real code examples in each guideline
|
||||
- [ ] Anti-patterns documented
|
||||
|
||||
When done:
|
||||
|
||||
```bash
|
||||
python3 ./.trellis/scripts/task.py finish
|
||||
python3 ./.trellis/scripts/task.py archive 00-bootstrap-guidelines
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Why This Matters
|
||||
|
||||
After completing this task:
|
||||
|
||||
1. AI will write code that matches your project style
|
||||
2. Relevant `/trellis:before-*-dev` commands will inject real context
|
||||
3. `/trellis:check-*` commands will validate against your actual standards
|
||||
4. Future developers (human or AI) will onboard faster
|
||||
@@ -0,0 +1,30 @@
|
||||
{
|
||||
"id": "00-bootstrap-guidelines",
|
||||
"name": "Bootstrap Guidelines",
|
||||
"description": "Fill in project development guidelines for AI agents",
|
||||
"status": "completed",
|
||||
"dev_type": "docs",
|
||||
"priority": "P1",
|
||||
"creator": "qzl",
|
||||
"assignee": "qzl",
|
||||
"createdAt": "2026-04-20",
|
||||
"completedAt": "2026-04-20",
|
||||
"commit": null,
|
||||
"subtasks": [
|
||||
{
|
||||
"name": "Fill backend guidelines",
|
||||
"status": "pending"
|
||||
},
|
||||
{
|
||||
"name": "Add code examples",
|
||||
"status": "pending"
|
||||
}
|
||||
],
|
||||
"children": [],
|
||||
"parent": null,
|
||||
"relatedFiles": [
|
||||
".trellis/spec/backend/"
|
||||
],
|
||||
"notes": "First-time setup task created by trellis init (backend project)",
|
||||
"meta": {}
|
||||
}
|
||||
Reference in New Issue
Block a user