How to apply this guide
Capture the problem, expected behavior and observed behavior as separate short sentences. Type code and exact error strings if speech changes them.
Start with
For a test issue, say “Opening settings twice shows a blank panel. Expected: show the account menu.” Add numbered reproduction steps in GitHub.
Check before you finish
Separate the minimal reproduction from observations about your larger system. Add a public screenshot only if you can verify every line it shows. Copy version numbers and filenames from their source where possible, because transcribing them can introduce one-character errors reviewers cannot reproduce.
Evidence to keep: Keep the target field open and verify that the complete reviewed result reached the intended destination. This page’s key limit is: Capture the problem, expected behavior and observed behavior as separate short sentences. Type code and exact error strings if speech changes them.
Make a short draft
For a test issue, say “Opening settings twice shows a blank panel. Expected: show the account menu.” Add numbered reproduction steps in GitHub.
Check the destination
Preview Markdown and remove any private logs or keys. Keep device and version details exact.
What to watch for
Separate the minimal reproduction from observations about your larger system. Add a public screenshot only if you can verify every line it shows. Copy version numbers and filenames from their source where possible, because transcribing them can introduce one-character errors reviewers cannot reproduce.




