|
2 | 2 |
|
3 | 3 | When creating or updating a plan: |
4 | 4 |
|
5 | | -1. Review `README.md` to understand the project. |
6 | | -2. Review `DOCS.md` (if exists) to understand the implementation. |
7 | | -3. Follow instructions in `.zed/agent/instructions/create-plan.md`. |
8 | | -4. Use the thinking tool. |
9 | | -5. Include README.md and DOCS.md updates in the plan. |
10 | | -6. Review existing plans for reference. |
| 5 | +1. Review README.md to understand the project. |
| 6 | +2. Review DOCS.md (if exists) to understand the implementation. |
| 7 | +3. Ensure plans for Rust files adhere to guidelines in |
| 8 | + `.zed/agent/guidelines/rust.md` strictly. |
| 9 | +4. Ensure plans for DOCS.md updates adhere to guidelines in |
| 10 | + `.zed/agent/guidelines/docs.md` strictly. |
| 11 | +5. Ensure plans for README.md updates adhere to guidelines in |
| 12 | + `.zed/agent/guidelines/readme.md` strictly. |
| 13 | +6. Follow instructions in `.zed/agent/instructions/create-plan.md`. |
| 14 | +7. Use the thinking tool. |
| 15 | +8. Include README.md and DOCS.md updates in the plan. |
| 16 | +9. Review existing plans for reference. |
11 | 17 |
|
12 | 18 | # Building Mode |
13 | 19 |
|
14 | 20 | When implementing a plan: |
15 | 21 |
|
16 | 22 | 1. Update the plan status as in progress. |
17 | | -2. Review `README.md` to understand the project. |
18 | | -3. Review `DOCS.md` (if exists) to understand the implementation. |
19 | | -4. Use the thinking tool. |
20 | | -5. Follow guidelines in `.zed/agent/guidelines/` for files being edited: |
21 | | - - `writing-rust-control-flow.md` + relevant modules for Rust files |
22 | | - - `writing-readme.md` for README.md |
23 | | - - `writing-docs.md` for DOCS.md Additional modules for Rust files: |
24 | | - - `writing-rust-error-handling.md` for error-related code |
25 | | - - `writing-rust-testing.md` for test code |
26 | | - - `writing-rust-documentation.md` for doc comments |
27 | | -6. Do not use git restore commands (can cause data loss). |
28 | | -7. Use `cargo test` to run tests and `rust-check` after changes. |
29 | | -8. Review and update the plan checklist after implementation. |
30 | | -9. Use `cargo install --path .` before running `cargo txt`. |
| 23 | +2. Review README.md to understand the project. |
| 24 | +3. Review DOCS.md (if exists) to understand the implementation. |
| 25 | +4. Follow guidelines in `.zed/agent/guidelines/rust.md` strictly when editing |
| 26 | + Rust files. |
| 27 | +5. Follow guidelines in `.zed/agent/guidelines/docs.md` strictly when editing |
| 28 | + DOCS.md. |
| 29 | +6. Follow guidelines in `.zed/agent/guidelines/readme.md` strictly when editing |
| 30 | + README.md. |
| 31 | +7. Use the thinking tool. |
| 32 | +8. Do not use git restore commands (can cause data loss). |
| 33 | +9. Use `cargo test` to run tests and `rust-check` after changes. |
| 34 | +10. Review and update the plan checklist after implementation. |
| 35 | +11. Use `cargo install --path .` before running `cargo txt`. |
31 | 36 |
|
32 | 37 | # Reviewing Mode |
33 | 38 |
|
34 | 39 | When reviewing staged changes: |
35 | 40 |
|
36 | 41 | 1. Update the plan status as in progress. |
37 | | -2. Review `README.md` to understand the project. |
38 | | -3. Review `DOCS.md` (if exists) to understand the implementation. |
39 | | -4. Use the thinking tool. |
40 | | -5. Follow the instructions in `.zed/agent/instructions/review-changes.md`. |
41 | | -6. Use `cargo test` to run tests and `rust-check` to verify changes. |
42 | | -7. Review the edited files: |
43 | | - - DOCS.md must strictly follow the guideline defined in |
44 | | - `.zed/agent/guidelines/writing-docs.md`. |
45 | | - - README.md must strictly follow the guideline defined in |
46 | | - `.zed/agent/guidelines/writing-readme.md`. |
47 | | - - Rust files must strictly follow the guidelines defined in: |
48 | | - - `.zed/agent/guidelines/writing-rust-control-flow.md` (always) |
49 | | - - `.zed/agent/guidelines/writing-rust-error-handling.md` (if errors |
50 | | - present) |
51 | | - - `.zed/agent/guidelines/writing-rust-testing.md` (if tests present) |
52 | | - - `.zed/agent/guidelines/writing-rust-documentation.md` (if docs |
53 | | - present) |
54 | | - - **CRITICAL**: All files in `.zed/agent/guidelines/` should read complete |
55 | | - full content, not just the outline. |
| 42 | +2. Review README.md to understand the project. |
| 43 | +3. Review DOCS.md (if exists) to understand the implementation. |
| 44 | +4. Ensure Rust files adhere to guidelines in `.zed/agent/guidelines/rust.md` |
| 45 | + strictly. |
| 46 | +5. Ensure DOCS.md updates adhere to guidelines in |
| 47 | + `.zed/agent/guidelines/docs.md` strictly. |
| 48 | +6. Ensure README.md updates adhere to guidelines in |
| 49 | + `.zed/agent/guidelines/readme.md` strictly. |
| 50 | +7. Use the thinking tool. |
| 51 | +8. Follow the instructions in `.zed/agent/instructions/review-changes.md`. |
| 52 | +9. Use `cargo test` to run tests and `rust-check` to verify changes. |
56 | 53 |
|
57 | 54 | # Git Commit Mode |
58 | 55 |
|
59 | 56 | When writing Git Commit message: |
60 | 57 |
|
61 | | -1. Review `README.md` to understand the project. |
62 | | -2. Review `DOCS.md` (if exists) to understand the current implementation. |
| 58 | +1. Review README.md to understand the project. |
| 59 | +2. Review DOCS.md (if exists) to understand the current implementation. |
63 | 60 | 3. Use the thinking tool. |
64 | 61 | 4. Follow instructions in |
65 | 62 | `.zed/agent/instructions/create-git-commit-message.md`. |
0 commit comments