Software projects
Write a bug report someone else can reproduce
A reproducible bug report lets a reader trigger the same problem without asking you anything. List the environment, number the steps from a clean starting point, state what you expected and what happened, and attach the smallest evidence that shows the difference.
A text to start with
I saw unexpected behavior in [product or project, version]. My rough notes are: [what you noticed]. I was using [operating system, browser or runtime, and relevant settings]. Rewrite this as a bug report with the environment, numbered steps from a fresh start, expected result, actual result, and minimal evidence. Mark any step where you are guessing, and list what I still need to check.
Example request. Change the details to fit your situation.Bug report worksheet
Short summary of the problem: [ ] Product, version or commit: [ ] Operating system and version: [ ] Browser, runtime or device: [ ] Settings or configuration that matter: [ ] Starting state (clean install, new account, empty project): [ ] Data or files needed, and how the reader can get them: [ ] Step 1: [ ] Step 2: [ ] Step 3: [ ] Expected result: [ ] Actual result: [ ] Happens every time, sometimes or once: [ ] Smallest evidence (error text, short log excerpt, cropped screenshot): [ ] Sensitive details removed: [ ] Steps I am unsure about: [ ]
Where reproduction steps break
Look for setup that exists only in your environment: sample data created earlier, an account-specific item, a saved setting or a local file. Describe what another person needs and provide a safe way to recreate it. Check that the starting state and step order match the attempt you observed. Describe the actual result precisely, then explain how it differs from the expected result. Remove tokens, passwords, personal data and private URLs from any logs or screenshots you share.
Ask another agent to check the result
Read these reproduction steps as someone with a fresh install and no access to my account. Point out every step that relies on data, files, settings or permissions I have not described. For each one, say what the reader would be missing and how I could supply it safely.
Test it, then file it
Follow your own steps on a fresh setup, or ask someone else to, and fix every point where they have to guess. Note whether the problem happens every time or only sometimes. Check the project's contribution guidance or issue template for the fields it asks for. GitHub documents issues for tracking bugs, ideas and work, so paste the finished report into the issue form you are using.