Skip to content

Commit b5d3da5

Browse files
[ViPPET][Copilot context] Add AI agent instructions file (AGENTS.md) to provide context and coding standards for GitHub Copilot (open-edge-platform#1840)
1 parent a982427 commit b5d3da5

File tree

4 files changed

+464
-0
lines changed

4 files changed

+464
-0
lines changed
Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
<!--SPDX-License-Identifier: Apache-2.0-->
2+
3+
# Copilot Instructions
4+
5+
## Scope
6+
7+
These instructions apply to the entire repository.
8+
9+
## Project Context
10+
11+
- ViPPET is a hardware-evaluation tool for AI workloads.
12+
- Backend: Python 3.12, FastAPI, Pydantic v2.
13+
- Frontend: React 19, shadcn components, react-hook-form, zod, recharts, react-router.
14+
- Runtime uses Docker Compose profiles: `cpu`, `gpu`, `npu`.
15+
16+
## Coding Rules
17+
18+
### Python
19+
20+
- Use type hints for new and modified code.
21+
- Use `async`/`await` for FastAPI route handlers.
22+
- Use Pydantic v2 APIs (for example `model_dump()`).
23+
- Use `logging` (never `print()`).
24+
- Keep changes small and focused.
25+
26+
### TypeScript
27+
28+
- Keep strict typing; avoid `any`.
29+
- Follow feature-based structure under `ui/src/features/`.
30+
- Use existing Redux Toolkit and Tailwind patterns.
31+
32+
## Repository Constraints
33+
34+
- Do not modify files under `shared/` as part of source changes.
35+
- Do not commit `.env` files or model artifacts.
36+
- Keep API schema and generated clients in sync when API changes.
37+
38+
## Validation Before Finishing
39+
40+
- Run relevant linters and tests for touched areas.
41+
- For docs-only changes, ensure `markdownlint` passes.
42+
- Do not include unrelated refactors in the same PR.
Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
<!--SPDX-License-Identifier: Apache-2.0-->
2+
3+
## Summary
4+
5+
Describe what changed and why.
6+
7+
## Checklist
8+
9+
- [ ] Scope is limited to the intended change.
10+
- [ ] No unrelated refactors were introduced.
11+
- [ ] Documentation was updated when behavior or API changed.
12+
- [ ] Relevant lint checks pass locally (`make lint`).
13+
- [ ] Relevant tests pass locally (`make test` or targeted tests).
14+
- [ ] API changes include OpenAPI/client regeneration when required.
15+
- [ ] No secrets, `.env` files, or model artifacts are included.
16+
17+
## Validation
18+
19+
List commands and outcomes used to verify this PR.
20+
21+
## Screenshots (if UI change)
22+
23+
Attach before/after images or short recordings.

0 commit comments

Comments
 (0)