Skip to content

docs: reorder role block, add SECURITY/CODE_OF_CONDUCT - #324

Merged
Pigbibi merged 1 commit into
mainfrom
docs/reorder-role-block-and-governance-files
Oct 6, 2026
Merged

Pigbibi merged 1 commit into
mainfrom
docs/reorder-role-block-and-governance-files

Conversation

@Pigbibi

@Pigbibi Pigbibi commented Oct 6, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Move the "QSL architecture role" / "QSL 架构角色" field-list block in both README.md and README.zh-CN.md to after the human-readable "What this repository is" / "这个仓库是什么" intro section, instead of before it. Pure reordering — no factual content changed (verified via git diff; the only other change is collapsing one redundant blank line that was part of the original double-blank-line artifact right after the title).
  • Add SECURITY.md and CODE_OF_CONDUCT.md, which did not exist in this repo (confirmed 404 before this change). CONTRIBUTING.md already existed and was left untouched.
    • Used QuantStrategyLab/BinancePlatform's merged SECURITY.md/CODE_OF_CONDUCT.md as a style reference only. Content here is rewritten for what this repo actually is — an A-share strategy-library package that does not hold broker credentials or execute orders — rather than reusing BinancePlatform's trading/broker-specific language.
    • Confirmed via gh api repos/QuantStrategyLab/CnEquityStrategies/private-vulnerability-reporting that private vulnerability reporting is not enabled for this repo, so SECURITY.md does not claim that channel exists; it points to direct maintainer contact instead.
    • Contact for both files is @Pigbibi (same as BinancePlatform's pattern); no other maintainer contact was found in CODEOWNERS/workflows in this repo.
  • Scanned README/CONTRIBUTING for the other known templated pattern ("中文摘要" duplicated boilerplate) — none found in this repo, so no additional fix was needed there.

Test plan

  • git diff README.md README.zh-CN.md shows only the block relocation (plus one incidental blank-line collapse), no wording changes.
  • gh api repos/QuantStrategyLab/CnEquityStrategies/private-vulnerability-reporting → {"enabled":false}, reflected accurately in SECURITY.md.
  • Confirmed SECURITY.md/CODE_OF_CONDUCT.md were 404 before this PR; CONTRIBUTING.md left untouched.

🤖 Generated with Claude Code

Both README.md and README.zh-CN.md had the "QSL architecture role" /
"QSL 架构角色" field-list block positioned before the human-readable
"What this repository is" intro section. Move it to come after that
section instead, so the plain-language description leads. Pure
reordering, no content changes.

Also add SECURITY.md and CODE_OF_CONDUCT.md, which were missing from
this repo. Content is tailored to what this repository actually does
(A-share strategy-library package, no broker credentials or order
execution), using BinancePlatform's merged files as a style reference
only. Confirmed via `gh api repos/QuantStrategyLab/CnEquityStrategies/private-vulnerability-reporting`
that private vulnerability reporting is not enabled, so SECURITY.md
does not claim that channel exists.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
@Pigbibi
Pigbibi merged commit 1d8bb25 into main Oct 6, 2026
2 checks passed
@Pigbibi
Pigbibi deleted the docs/reorder-role-block-and-governance-files branch October 6, 2026 18:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant