如何贡献
BioInfo Wiki 采用开源协作模式，通过 GitHub 的 Issue 和 Pull Request 机制持续积累内容。本页说明贡献流程、内容标准和优先方向。
1. 贡献流程
Section titled “1. 贡献流程”
1.1 准备工作
Section titled “1.1 准备工作”-
阅读相关文档：
-
确认贡献方向：
- 查看已有 Issue，寻找感兴趣的任务
- 或开新 Issue 提议新增/修改内容，等待维护者反馈
1.2 提交修改
Section titled “1.2 提交修改”- Fork 本仓库并创建特性分支
- 按写作规范修改文档、插画或代码
- 本地验证：
npm installnpm run dev # 本地预览npm run check # 检查链接和格式- 提交 Pull Request，说明：
- 修改目标和解决的问题
- 影响的具体页面
- 是否新增图片/组件/目录结构
- 验证方式和测试结果
2. 内容贡献的优先方向
Section titled “2. 内容贡献的优先方向”当前阶段优先欢迎以下内容：
| 优先级 | 方向 | 具体示例 |
|---|---|---|
| 高 | 基础桥接页 | reads、coverage、参考基因组、文件格式 |
| 高 | 算法主线页 | 索引结构、比对算法、组装图、概率模型 |
| 中 | 工作流页 | DNA-seq、RNA-seq、宏基因组分析流程 |
| 中 | 数据资源页 | 数据库入口、版本选择、对象映射 |
| 低 | 装饰性优化 | 纯视觉改进而无实质内容增益的修改 |
3. 内容质量标准
Section titled “3. 内容质量标准”3.1 必备要素
Section titled “3.1 必备要素”每篇知识页面应至少包含：
- 清晰的主题定位 — 这页在讲什么、适合谁读
- 问题背景 — 为什么这个主题值得讲
- 核心概念或方法 — 关键模型、算法或流程
- 实例或图示 — worked example、流程图或对比表
- 参考资料 — 引用的论文、教材或官方文档
- 相关页面链接 — 站内交叉引用，形成知识网络
3.2 写作原则
Section titled “3.2 写作原则”- 问题优先：先说明要解决什么问题，再给出方法
- 解释关系：解释概念之间的联系，而非堆砌术语
- 形式化表达：需要时用公式、伪代码或图示清晰描述
- 工具映射：说明算法思想如何体现在实际工具中
- 标注局限：说明方法的前提假设和适用范围
3.3 术语与格式
Section titled “3.3 术语与格式”- 正文使用简体中文，关键术语首次出现时附英文（如”隐马尔可夫模型（Hidden Markov Model, HMM）”）
- 数据库、软件、经典算法名称保留英文
- 优先使用
.md格式，需要交互组件时再使用.mdx - 图片放入
public/img/illustrations/或public/img/figures/，确保暗色模式下可读
4. 技术贡献
Section titled “4. 技术贡献”4.1 组件与样式
Section titled “4.1 组件与样式”- 优先复用
src/components/docs/中已有组件 - 新增组件保持 API 简洁，便于后续文档复用
- 样式修改优先使用
src/styles/custom.css
4.2 站点配置
Section titled “4.2 站点配置”- 新增或重命名页面时，同步检查
astro.config.mjs中的 sidebar 配置 - 修改后运行
npm run check验证链接和配置
5. 审核与合并
Section titled “5. 审核与合并”维护者会在 PR 提交后尽快审核，关注以下方面：
- 内容准确性和技术正确性
- 与现有知识体系的兼容性
- 是否符合写作规范和术语标准
- 是否补充了必要的交叉链接
小额修改（如错别字、链接修正）通常快速合并；较大内容新增可能需要多轮讨论。