Repository navigation
docs: add a concise reproducible issue guide - #18
Merged
Merged
Conversation
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.
The README explains how to run TradeForge but does not tell first-time users which details make a backend- or seed-dependent failure reproducible. Add a short Issues entry point and a checklist covering revision, environment, full command, active doctor backend, configuration/seed, a minimal public or synthetic fixture, and expected versus actual results.
Link the existing extending guide for code contributions. The first-run instructions, result tables, assumptions and all other README text are preserved.
Validation: four existing documented-command checks passed. The version command, doctor with explicit configs, and doctor/demo/run help were executed successfully; backend and seed semantics were cross-checked against the CLI and configuration loader. Independent review verified that README is the only changed source file and that removing the new section restores the original README byte for byte. No runtime, dependency, test or CI changes.