Repository navigation
docs: reorder architecture-role block, add SECURITY/CODE_OF_CONDUCT - #49
Merged
Merged
Conversation
- Move the "QSL architecture role" field-list block in README.md and README.zh-CN.md to after the human-readable intro section, so readers hit the plain-language description before the structured metadata. Pure reordering; no factual content changed. - Add SECURITY.md and CODE_OF_CONDUCT.md (previously missing), tailored to this repo's actual scope as an artifact/snapshot pipeline rather than a trading execution platform. 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
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.mdandREADME.zh-CN.mdto come after the human-readable "What this repository is" intro section (was positioned before it). Pure reordering — content of the block and the intro section is unchanged; verified via diff that only position moved.SECURITY.mdandCODE_OF_CONDUCT.md, which did not exist in this repo (confirmed 404 before this change). Content is tailored to what this repo actually does — an A-share factor-snapshot/artifact/evidence pipeline that does not place broker orders or store broker credentials — rather than copying trading-platform-specific language from other QSL repos. Checkedprivate-vulnerability-reportingvia the GitHub API (currently disabled for this repo) before wording the reporting channel as conditional rather than claiming it's active.CONTRIBUTING.mdalready existed and was already fine; left untouched.Test plan
git diffon README.md / README.zh-CN.md confirms only the block's position changed (sorted non-blank lines are identical between old and new versions).gh api repos/QuantStrategyLab/CnEquitySnapshotPipelines/private-vulnerability-reportingthat private vulnerability reporting is currently disabled; SECURITY.md wording reflects this conditionally rather than asserting it's an active channel.🤖 Generated with Claude Code