贡献指南

感谢你对 MolOP 的关注！我们欢迎各种形式的贡献。

• 报告 Bug：如何提交有效的 Issue。
• 提交功能建议：分享你对 MolOP 的改进想法。
• 代码贡献流程：从 Fork 到 Pull Request 的详细步骤。
• 开发环境搭建：如何配置本地开发环境。
• 代码风格规范：遵循 Ruff 和类型检查要求。
• 文档规范：使用统一的四层文档标准（style_guide.md）。

文档质量保证

为了确保高质量的文档，我们执行以下政策：

• CI 验证：每个 Pull Request 都会触发使用 mkdocs build --strict 的文档构建。这确保了没有损坏的内部链接和有效的配置。
• 翻译政策：
• 我们使用 TODO(translate): 作为中英文之间尚未翻译内容的占位符。
• 占位符允许存在于 main 分支和 Pull Request 中，以实现阶段性同步。
• 发布阻断：发布标签（v*）中严禁出现占位符。如果在发布构建期间检测到任何占位符，CI 将失败。
• Notebooks：文档中的 Jupyter notebook 是可选的，且不会由 CI 执行。如果你希望输出可见，请确保它们已预先执行。