Bug Triage
Follow this 8-step triage process before implementing any bug fix. Do not skip triage.
Triage Steps
- Verify you have all information needed to reproduce the bug (authentication requirements, environment information, etc.). Do not make assumptions. If anything is missing, stop and ask before proceeding.
- Reproduce the bug. If you cannot reproduce it, stop and report what you tried and what you observed.
- Once reproduced, verify you are 100% positive on how to fix it. If not, determine what you need to do to be 100% positive (e.g. add logging, trace the code path, inspect state) and do that first.
- Verify you have access to the tools, environments, and permissions needed to deploy and verify this fix (e.g. CI/CD pipelines, deployment targets, logging/monitoring systems, API access, database access). If any are missing or inaccessible, stop and raise them before starting implementation.
- Define the tests you will write to confirm the fix and prevent a regression.
- Define the documentation you will create or update to explain this bug so another developer understands the "how" and "what" behind it.
- If you can verify your fix before deploying to the target environment (e.g. start the app, invoke the API, open a browser, run the process, check logs), do so before deploying.
- Define how you will verify the fix beyond a shadow of a doubt (e.g. deploy to the target environment, invoke the API, open a browser, run the process, check logs).
Implementation
Use the output of the triage steps above as your guide. Do not skip triage.