Repository navigation
docs: human-readable README intro order + add governance files - #67
Merged
Merged
Conversation
Move the QSL architecture role field list after the human-readable intro paragraphs (including the offline dry-run only boundary) in README.md and README.zh-CN.md, with no content changes. Add CONTRIBUTING.md, SECURITY.md, and CODE_OF_CONDUCT.md, which were missing, matching this repo's actual dry-run-only scope and local verification commands. Co-Authored-By: Claude Sonnet 5 <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
README.md/README.zh-CN.md: moved theQSL architecture rolefield list to after the human-readable intro paragraphs (including the "offline dry-run only" risk-boundary text), matching the order already used in sibling repos. No wording or factual content changed — only section order.CONTRIBUTING.md,SECURITY.md,CODE_OF_CONDUCT.md, written to match this repo's actual scope (QMT/miniQMT A-share execution runtime, offline dry-run only — any non-dry-run order request is rejected asblocked, never reported assubmitted) and its real local verification commands (ruff check,pytest,preflight_qmt_runtime.py, the dry-run smoke scripts) taken from.github/workflows/ci.yml.Test plan
README.md/README.zh-CN.mdchanges: confirmed only section reordering, no text added/removed/reworded.scripts/preflight_qmt_runtime.py,scripts/smoke_cn_industry_etf_rotation_dry_run_e2e.py,ruff check .,pytest tests), cross-checked against.github/workflows/ci.yml.🤖 Generated with Claude Code