Skip to content

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

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

Pigbibi merged 1 commit 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: replaced the bare "## QSL architecture role" field list at the top with a 2-4 sentence plain-language introduction to what this repo does; the original field list is preserved verbatim, just moved to a mid-document section.
  • CONTRIBUTING.md, SECURITY.md, CODE_OF_CONDUCT.md: removed the templated "## 中文摘要" metadata block (identical across all QSL repos, only the repo name swapped).
  • CONTRIBUTING.md: the one non-redundant point from its summary block (verify live-trading/credential/permission/Cloud Run/exchange-API changes in a test environment or dry run first) was folded into "Ground Rules" as a normal bullet instead of being dropped.
  • SECURITY.md and CODE_OF_CONDUCT.md: the summary's risk-reminder content was already fully covered by the existing body sections (Secret and Credential Exposure; Our Standards / Project Scope), so nothing else needed to move.

Test plan

  • Doc-only change; no code touched.
  • Reviewed resulting Markdown renders correctly (headings, links, code fences intact).
  • Confirmed no other file in the repo still contains the "中文摘要" block or the raw architecture-role list.

🤖 Generated with Claude Code

README.md/README.zh-CN.md now open with a plain-language introduction
instead of a raw "QSL architecture role" field list (moved mid-document).
CONTRIBUTING.md, SECURITY.md, and CODE_OF_CONDUCT.md drop the repeated
"## 中文摘要" metadata block; the one piece of unique guidance in
CONTRIBUTING.md's summary (verify live-trading/credential/Cloud Run
changes in a test environment first) is folded into Ground Rules.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
@Pigbibi
Pigbibi merged commit a0c6590 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