Add ROADMAP, issue/PR templates, and discussion routing#56
Merged
Conversation
- ROADMAP.md: direction document grounded in open issues/discussions, with an explicit out-of-scope section so contributors know what the project will and will not become. - Issue templates: bug_report.yml (engine-aware, asks for repro + which engine produced the divergence) and feature_request.yml (gated by a scope check against the README's "What It Is Not"). - config.yml routes open-ended questions to Discussions and points curious readers to the Markets in Production landing page. - PULL_REQUEST_TEMPLATE.md: short checklist focused on engine equivalence, fixtures, and CHANGELOG updates. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
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.
Summary
Closes the small remaining gaps in the contributor scaffolding inventory. Repo metadata (
homepageUrl → https://marketsinproduction.com/ordersim/) was set directly via the API.ROADMAP.md— Direction document, no dates. Grounded in actual open issues (#39, #40) and Discussions (hidden liquidity, venue matching). Has an explicit out-of-scope section that mirrors the README's "What It Is Not"..github/ISSUE_TEMPLATE/bug_report.yml— Engine-aware (asks which engine produced the divergence), requires repro..github/ISSUE_TEMPLATE/feature_request.yml— Gated by a scope check against the "What It Is Not" framing..github/ISSUE_TEMPLATE/config.yml— Disables blank issues, routes open-ended questions to Discussions, links to Markets in Production for editorial context..github/PULL_REQUEST_TEMPLATE.md— Short checklist focused on engine equivalence, fixtures, andCHANGELOG.md.Why now
The Trading Reality / Markets in Production ecosystem brief identified GitHub contributor gravity as a key gap. Most of the scaffolding (CONTRIBUTING, LICENSE, labels, topics, Discussions, examples, tests) was already in place. These additions close the remaining items so an arriving contributor sees the project's direction, has structured paths for bug reports and feature requests, and gets routed to Discussions for anything open-ended.
Test plan