Skip to content

docs: README 贡献区未链接 CONTRIBUTING.md #411

Open
wannT-1/folio
#4

Description

@wannT-1

现象

仓库根目录有完整的 CONTRIBUTING.md(中文:认领规则、commit 规范、PR 测试报告模板、截图要求、安全等),但:

  • README.md「参与贡献」只写了 bun test / bun run typecheck 与截图一句;
  • README.en.md 「Contributing」同样没有链到 CONTRIBUTING.md;
  • 「文档」列表也未列出贡献指南。

新贡献者从 README 进仓时看不到 claim、Closes #N、正式测试报告等硬性要求,容易开出不符合维护者门槛的 PR。

建议修复(小范围 docs)

  1. 中英 README 的贡献段各加一句指向 CONTRIBUTING.md(英文可链同一文件,或注明文档为中文)。
  2. 可选:在「文档」列表增加一行贡献指南。

不改贡献规则正文本身。

查重

搜索 CONTRIBUTING 相关 open issue 未见同类。

Activity

  1. wannT-1 commented on Oct 30, 2026

    @wannT-1
    Author

    /claim

    我来补 README.md / README.en.md 对 CONTRIBUTING.md 的链接(可选加进文档列表)。提交 PR 时写 Closes #411。

  2. github-actions commented on Oct 30, 2026

    @github-actions

    @wannT-1 已认领该 Issue,并已自动设为 Assignee。提交 PR 时请在描述中写 Closes #411。

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

claimedClaimed by a contributor and currently in progress

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions