upleb.uk

Public git repos — served from a NIP-34 GRASP relay at git.upleb.uk

summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/how-to/production-sync-testing.md39
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
161. Check for active issues: `ls work/active-issues/` 161. Check for active issues: `ls work/active-issues/`
172. Pick the most important issue to fix 172. Pick the most important issue to fix
183. Implement the fix 183. **Review proposed fix and ask for permission before implementing**
194. Run `cargo test` to verify tests pass 194. Implement the fix (after approval)
205. Run `cargo clippy` to check for warnings 205. Run `cargo test` to verify tests pass
216. Run `cargo fmt` to format code 216. Run `cargo clippy` to check for warnings
227. Commit changes with descriptive message 227. Run `cargo fmt` to format code
238. Report back - **DO NOT** do another issue or run more tests 238. Commit changes with descriptive message
249. 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
213Make the necessary code changes based on the issue description. 214**IMPORTANT:** Before implementing any changes:
214 215
215### Step 4: Test, Lint, Format 2161. Read relevant code files to understand the issue
2172. Analyze the root cause
2183. Propose a fix with explanation of what will change and why
2194. Summarize the proposed fix in 2-3 sentences
2205. **Ask for user permission to proceed**
221
222**Do NOT implement changes without explicit approval.**
223
224### Step 4: Implement the Fix
225
226After 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
225cargo fmt 238cargo fmt
226``` 239```
227 240
228### Step 5: Commit 241### Step 6: Commit
229 242
230```bash 243```bash
231git add . 244git add .
232git commit -m "fix: [brief description of what was fixed]" 245git 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