Skip to content

Commit 1bee52b

Browse files
committed
Add AGENT.md
1 parent e79aaec commit 1bee52b

1 file changed

Lines changed: 12 additions & 0 deletions

File tree

AGENT.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# General
2+
- All comment and document must be in English.
3+
- Omit unnecessary obvious comment during coding.
4+
- For the document, must be concise, well organize into catelog, no duplicated topic, no redundant information. Relative topic should be organize in near position.
5+
- If you don't know 3rd-party API, should lookup on `https://docs.rs/<crate>`.
6+
- Do not run cargo clippy
7+
- Run test with `make test`. In order to prevent too long output truncated by AI tool, run test with `make test <test_name>` when you have a targeted test case.
8+
- Always use shorter token path by importing the trait or structure.
9+
10+
# Execution plan
11+
12+
Create execution plan with steps when going large design, store into `docs/(topic)_steps.md`, wait for review.

0 commit comments

Comments
 (0)