Skip to content

docs: rewrite governance templates into human-readable prose - #67

Merged
Pigbibi merged 2 commits into
mainfrom
docs/human-readable-governance-and-readme
Oct 6, 2026
Merged

Pigbibi merged 2 commits into
mainfrom
docs/human-readable-governance-and-readme

Conversation

@Pigbibi

@Pigbibi Pigbibi commented Oct 6, 2026

Copy link
Copy Markdown
Collaborator

Summary

  • README.md / README.zh-CN.md: moved the templated "QSL architecture role" bullet list out of the opening lines and replaced it with a 2-4 sentence natural-language introduction (same facts, no new claims); the list now lives as its own mid-document section. The Chinese-README link and the investing-risk disclaimer are preserved.
  • CONTRIBUTING.md / SECURITY.md: removed the duplicated "## 中文摘要" meta-description block (identical boilerplate across all QSL sibling repos except the repo name). The one risk note worth keeping ("live trading/credential/Cloud Run/broker changes need test or dry-run verification first") was folded into CONTRIBUTING.md's Ground Rules as a normal bullet.
  • SECURITY.md's actual security content — vulnerability reporting, secret/credential exposure steps, scope notes — is untouched, word for word.

No code changes.

Additional finding (not fixed, out of the requested scope)

CODE_OF_CONDUCT.md has the same "## 中文摘要" meta-block pattern as CONTRIBUTING.md/SECURITY.md did. Left as-is since it wasn't in the requested file list; flagging in case a follow-up PR should cover it too.

Test plan

  • Diff-reviewed each file to confirm no SECURITY.md procedural content was dropped
  • Confirmed README facts (layer/responsibility/owns/consumes/must-not) are unchanged, just relocated
  • N/A — documentation only, no code/tests affected

🤖 Generated with Claude Code

Pigbibi and others added 2 commits October 7, 2026 00:58
Replace the machine-generated "QSL architecture role" block at the top
of the README and the near-identical "中文摘要" boilerplate in
CONTRIBUTING.md/SECURITY.md with natural-language text, so the docs
read like something a maintainer wrote rather than a template fill-in.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Drop the same mechanically-generated "## 中文摘要" block already
removed from CONTRIBUTING.md/SECURITY.md. Its risk note (be
conservative/reproducible/evidence-oriented about investing, trading,
credentials, and live systems) is already covered by the existing
"Our Standards" and "Project Scope" sections, so nothing needed to be
folded into the body.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
@Pigbibi
Pigbibi merged commit b69e63c into main Oct 6, 2026
@Pigbibi
Pigbibi deleted the docs/human-readable-governance-and-readme branch October 6, 2026 17:22
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