This guide applies to every repository of this account that does not have its own CONTRIBUTING.md. A repository's own guide takes precedence.
本指南适用于本账户下所有没有自带 CONTRIBUTING.md 的仓库;仓库自带的指南优先。
- Use the issue forms. Bug reports, feature requests and other topics each have an English and a Chinese form; pick the language you are comfortable with.
- Search open and closed issues first, and use a short, specific title.
Pull requests are welcome. If a repository has pull requests enabled, it accepts contributions — no need to ask first.
Every pull request must include:
- Why. Explain the problem or motivation behind the change, not only what changed. Link the related issue if there is one.
- How to verify. The change must be reliably verifiable. Give the exact steps, commands or tests a reviewer can run, and the expected result. Existing builds and tests must still pass.
- AI disclosure. If you used AI tools (code generation, agents, chat assistants, etc.), check the AI disclosure box in the pull request. AI-assisted contributions are very welcome; the disclosure is required. You remain responsible for understanding and standing behind every line you submit.
Also:
- Keep each pull request focused on one change, and follow the existing code style.
- For larger changes, consider opening an issue first so the approach can be agreed on before you spend time on it.
Pull requests missing the explanation, the verification steps or a required AI disclosure may be closed without review.
Opening a pull request means you accept the Contributor License Agreement for that contribution. No separate signature is needed.
If these projects help you, you can support them through the Sponsor button of the repository.
- 请使用 Issue 表单。Bug 反馈、功能建议和其他问题都有中文和英文两种表单,选择你习惯的语言即可。
- 提交前先搜索已有和已关闭的 Issue,并写一个简短明确的标题。
非常欢迎 Pull Request。只要仓库开启了 Pull Request 功能,就表示欢迎贡献,无需事先询问。
每个 Pull Request 必须写明:
- 为什么改。 说明改动要解决的问题或动机,而不只是改了什么;有相关 Issue 时请关联。
- 如何验证。 改动必须能被可靠地验证。写出审阅者可以照做的具体步骤、命令或测试,以及预期结果;项目现有的构建和测试仍须通过。
- AI 使用声明。 如果使用了 AI 工具(代码生成、Agent、对话助手等),请在 Pull Request 中勾选 AI 使用声明。非常欢迎 AI 参与的贡献,但声明是必要的。你仍需理解并对提交的每一行负责。
此外:
- 每个 Pull Request 只做一件事,并遵循现有代码风格。
- 较大的改动可以先开 Issue,商定方案后再动手。
缺少改动理由、验证方式或应有的 AI 声明的 Pull Request 可能会被直接关闭。
提交 Pull Request 即表示你就该贡献接受贡献者许可协议,无需另行签署。
如果这些项目对你有帮助,可以通过仓库的 Sponsor 按钮支持。