docs: reproduce-before-you-fix instructions for contributors and AI agents#4254
Merged
Conversation
…AI agents Adds .github/REPRODUCING.md and references it from the bug report template, the PR template, and AGENTS.md: reproduce the issue before fixing (provoke it with loops/threads/timing stress and temporary instrumentation when needed), package the reproducer as a toggleable component, and verify the fix against it with before/after evidence.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Adds
.github/REPRODUCING.md— reproduction expectations for bug reports and fixes. They apply to all contributors, and especially to AI coding agents: make every effort to reproduce before fixing, provoke hard-to-hit bugs (loops, bursts, thread/timing stress, temporary instrumentation, sanitizers), package the reproducer as a self-contained toggleable component, and verify the fix against it with before/after evidence. Referenced from the bug report template, the PR template,CONTRIBUTING.md, andAGENTS.md.Motivated by #4252/#4253, where reproducing the crash showed a different root cause than the code-reading analysis suggested.
Checklist
CONTRIBUTING.mdyarn generatein the root folder/exampleapp./example)