diff options
| author | DanConwayDev <DanConwayDev@protonmail.com> | 2026-01-09 23:20:01 +0000 |
|---|---|---|
| committer | DanConwayDev <DanConwayDev@protonmail.com> | 2026-01-09 23:20:01 +0000 |
| commit | 5c68d55b59cc7e59f2a618926059ac3f405876d0 (patch) | |
| tree | ff17ddcfa089e3ed5aca7b6e9c74bef9a7ca1972 | |
| parent | fe64d3754058aacdce80f8339d99f851a9e5987d (diff) | |
docs: add permission step to fix mode workflow
Mode 1 (Fix Existing Issues) now requires reviewing the proposed fix
and asking for user permission before implementing changes. This ensures
users have visibility and control over what code changes are made.
Changes:
- Added Step 3: Review Proposed Fix and Get Permission
- Renumbered subsequent steps (4-7)
- Updated both overview and detailed workflow sections
- Updated workflow diagram to show review/permission steps
| -rw-r--r-- | docs/how-to/production-sync-testing.md | 39 |
1 files changed, 27 insertions, 12 deletions
diff --git a/docs/how-to/production-sync-testing.md b/docs/how-to/production-sync-testing.md index d5c11ea..3a14791 100644 --- a/docs/how-to/production-sync-testing.md +++ b/docs/how-to/production-sync-testing.md | |||
| @@ -15,12 +15,13 @@ This guide operates in two modes: | |||
| 15 | 15 | ||
| 16 | 1. Check for active issues: `ls work/active-issues/` | 16 | 1. Check for active issues: `ls work/active-issues/` |
| 17 | 2. Pick the most important issue to fix | 17 | 2. Pick the most important issue to fix |
| 18 | 3. Implement the fix | 18 | 3. **Review proposed fix and ask for permission before implementing** |
| 19 | 4. Run `cargo test` to verify tests pass | 19 | 4. Implement the fix (after approval) |
| 20 | 5. Run `cargo clippy` to check for warnings | 20 | 5. Run `cargo test` to verify tests pass |
| 21 | 6. Run `cargo fmt` to format code | 21 | 6. Run `cargo clippy` to check for warnings |
| 22 | 7. Commit changes with descriptive message | 22 | 7. Run `cargo fmt` to format code |
| 23 | 8. Report back - **DO NOT** do another issue or run more tests | 23 | 8. Commit changes with descriptive message |
| 24 | 9. Report back - **DO NOT** do another issue or run more tests | ||
| 24 | 25 | ||
| 25 | ### Mode 2: Discover New Issues | 26 | ### Mode 2: Discover New Issues |
| 26 | **When:** No active issues in `work/active-issues/` | 27 | **When:** No active issues in `work/active-issues/` |
| @@ -208,11 +209,23 @@ Review issue files and select based on: | |||
| 208 | - Impact (functionality > performance > UX) | 209 | - Impact (functionality > performance > UX) |
| 209 | - Complexity (quick fixes first to clear backlog) | 210 | - Complexity (quick fixes first to clear backlog) |
| 210 | 211 | ||
| 211 | ### Step 3: Implement the Fix | 212 | ### Step 3: Review Proposed Fix and Get Permission |
| 212 | 213 | ||
| 213 | Make the necessary code changes based on the issue description. | 214 | **IMPORTANT:** Before implementing any changes: |
| 214 | 215 | ||
| 215 | ### Step 4: Test, Lint, Format | 216 | 1. Read relevant code files to understand the issue |
| 217 | 2. Analyze the root cause | ||
| 218 | 3. Propose a fix with explanation of what will change and why | ||
| 219 | 4. Summarize the proposed fix in 2-3 sentences | ||
| 220 | 5. **Ask for user permission to proceed** | ||
| 221 | |||
| 222 | **Do NOT implement changes without explicit approval.** | ||
| 223 | |||
| 224 | ### Step 4: Implement the Fix | ||
| 225 | |||
| 226 | After receiving permission, make the necessary code changes based on the issue description and approved plan. | ||
| 227 | |||
| 228 | ### Step 5: Test, Lint, Format | ||
| 216 | 229 | ||
| 217 | ```bash | 230 | ```bash |
| 218 | # Run tests | 231 | # Run tests |
| @@ -225,14 +238,14 @@ cargo clippy | |||
| 225 | cargo fmt | 238 | cargo fmt |
| 226 | ``` | 239 | ``` |
| 227 | 240 | ||
| 228 | ### Step 5: Commit | 241 | ### Step 6: Commit |
| 229 | 242 | ||
| 230 | ```bash | 243 | ```bash |
| 231 | git add . | 244 | git add . |
| 232 | git commit -m "fix: [brief description of what was fixed]" | 245 | git commit -m "fix: [brief description of what was fixed]" |
| 233 | ``` | 246 | ``` |
| 234 | 247 | ||
| 235 | ### Step 6: Report Back | 248 | ### Step 7: Report Back |
| 236 | 249 | ||
| 237 | **STOP HERE.** Report what was fixed. Do NOT: | 250 | **STOP HERE.** Report what was fixed. Do NOT: |
| 238 | - Fix another issue | 251 | - Fix another issue |
| @@ -388,7 +401,9 @@ Check work/active-issues/ | |||
| 388 | │ | 401 | │ |
| 389 | ├─ Has issues? ──► Mode 1: Pick one issue | 402 | ├─ Has issues? ──► Mode 1: Pick one issue |
| 390 | │ │ | 403 | │ │ |
| 391 | │ ├─ Fix code | 404 | │ ├─ Review & propose fix |
| 405 | │ ├─ Ask permission | ||
| 406 | │ ├─ Fix code (after approval) | ||
| 392 | │ ├─ cargo test | 407 | │ ├─ cargo test |
| 393 | │ ├─ cargo clippy | 408 | │ ├─ cargo clippy |
| 394 | │ ├─ cargo fmt | 409 | │ ├─ cargo fmt |