Find the cause, not the symptom
What it produces
A named cause at file:line, a check that fails because of it, and only then a fix.
Steps
- Reproduce it. If you cannot reproduce it, say so plainly and stop guessing: the next useful thing is a way to reproduce it, not a change.
- Read the failing output in full. The first error is usually the real one and the rest are its consequences; the last error is the one people paste.
- Name a cause you can point at.
file:line, and one sentence on why that line produces this symptom. "Probably a race" is not a cause. If two causes are plausible, say which observation would tell them apart, then go and make that observation. - Before the fix, write the check that fails for this reason. A fix with no failing check before it is a change with an opinion attached.
- Fix the cause, at the place all the callers go through. Patching the one path the report named leaves every sibling caller broken, and the shared fix is usually the smaller diff.
- Run the check. Then run the suite. Then say what you changed and why it fixes the cause you named, not the symptom that was reported.
- If you are two attempts in and it is still not fixed, stop and say so. That is a rule, not a suggestion: the third attempt is where the guessing starts.
Conflicts
Read both sides for intent before touching either. Lock files and generated files are regenerated, never merged by hand. Migrations are ordered, not combined. If two people meant different things, that is a conversation, not a resolution.
What this is not
- "I know what the bug is even though I cannot reproduce it" — a cause you cannot reproduce is a guess: the next useful thing is a way to reproduce it, not a change.
Done when
- The cause is named at
file:lineand a person could disagree with it. - A check exists that fails without the fix and passes with it.
- You said what you changed, in a sentence somebody could act on.