Skip to content

Commit 36d4ca5

Browse files
docs: add AGENTS baseline
1 parent 003585d commit 36d4ca5

1 file changed

Lines changed: 28 additions & 0 deletions

File tree

AGENTS.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# AGENTS.md for BlackRoad-OS/adaptive-edge-ai-optimizer
2+
3+
# Repository Guidelines
4+
5+
## Session Start
6+
- Review the root `README.md` first for product context and local run instructions.
7+
- Check for existing automation, deployment, and workflow files before adding new ones.
8+
9+
## Project Structure
10+
- Keep source changes inside the repo's existing app, package, or service structure.
11+
- Prefer root-level documentation updates only when clarifying setup, architecture, or contributor workflow.
12+
13+
## Development Workflow
14+
- Use the repo's existing package manager and task runner.
15+
- Prefer small, reviewable changes over broad refactors.
16+
- Preserve current file naming, formatting, and framework conventions.
17+
18+
## Validation
19+
- Run the lightest relevant verification step available for the repo.
20+
- If the repo exposes lint, type-check, or test commands, prefer those before broader builds.
21+
22+
## Changes
23+
- Update documentation when behavior, setup, or commands change.
24+
- Avoid destructive rewrites of unrelated files.
25+
- Keep automation and local model tooling additive unless the repo already has a stronger pattern.
26+
27+
## Pull Requests
28+
- Summarize user-visible changes, validation performed, and any required config changes.

0 commit comments

Comments
 (0)