Contributing｜参与贡献

感谢你帮助 Yangming Mind OS 变得更可靠、更易用。English guidance follows the Chinese section.

贡献方向

• 核对原典出处、版本和误引
• 改进模板的可填写性
• 贡献匿名化的真实场景案例
• 把英文改得自然，而不是逐字翻译
• 修复链接、格式、可访问性或文档站问题
• 补充 Obsidian / Markdown 使用流程

内容边界

提交前请确认内容明确属于下列一层，并在 PR 中说明：

1. 原典引文：注明书名、卷次/篇章及版本。
2. 现代解释：明确是解释，不使用引号伪装成原话。
3. 应用建议：明确是本项目或贡献者设计的现代工具。

请先阅读引用与来源规范。无法确认出处时，标记“出处待核实”，不要猜测。

隐私与安全

不要提交私人日记、真实姓名、公司机密、未授权对话、API key、token、密码、医疗记录或可识别他人的信息。案例请合成或充分匿名化。

提交 Issue

选择最接近的 Issue 模板：Bug、功能建议、内容纠错、翻译贡献或新案例。一个 Issue 只处理一个清楚的问题。

适合第一次贡献的任务见 GOOD_FIRST_ISSUES.md。

提交 Pull Request

1. Fork 仓库并从 main 创建短分支。

2. 保持改动聚焦，不把无关重写放在同一个 PR。

3. 对新文档补充 frontmatter、返回入口和下一篇推荐。

4. 运行检查：

   npm ci
   npm run quality

5. 在 PR 中说明：问题、改动、内容层级、来源、检查结果与风险。

文档格式

• 使用清楚的标题层级，每个文件只有一个 H1。
• 中英文之间保留空格；标点跟随所在语言。
• 目录使用 README.md 作为导航入口。
• 相对链接优先；链接到外部资料时说明用途。
• updated 使用 YYYY-MM-DD。
• 模板应能复制后直接填写，案例应展示填写结果。

English guidance

Contributions are welcome in source verification, natural English, worksheet usability, anonymized cases, Obsidian workflows, accessibility, and documentation maintenance.

• Keep historical text, modern interpretation, and project-authored application guidance visibly separate.
• Do not submit copyrighted modern translations, private journals, identifying details, credentials, or confidential workplace material.
• English content should explain unfamiliar context rather than mirror Chinese sentence structure.
• Run npm ci and npm run quality before opening a focused pull request.
• Describe the source, intended user outcome, validation, and remaining risk in the PR body.

Review standard

Maintainers prioritize factual traceability, practical usefulness, safety, plain language, and maintainability. A smaller verified improvement is more valuable than a broad unverified rewrite.

By contributing, you agree that your contribution is available under the repository's MIT License, and that you have the right to submit it.