企业官网建设流程全解析

HiC_tools 贡献指南：从看懂 Hi-C 工具库到发出第一个 PR 的完整流程

【免费下载链接】awesome-public-datasetsA topic-centric list of HQ open datasets.项目地址: https://gitcode.com/GitHub_Trending/aw/awesome-public-datasets

HiC_tools 是一个开源的 Hi-C 数据分析工具库，把数百条分析流水线、TAD/Loop 调用器、归一化方法与可视化工具按功能章节集中收录。对第一次向 HiC_tools 贡献新工具的同学来说，最大的门槛不是技术，而是「条目该写在哪、写成什么样」。这份 HiC_tools 贡献指南带你走通从熟悉仓库、准备环境、起草工具条目到发出 PR 的完整流程，读完即可动手 ✨

仓库长什么样：先把家底摸清楚

HiC_tools 是一个以文档为主的项目，条目本体就维护在 README 里，没有复杂的构建体系。动手前花几分钟认识下面几个关键文件，后面每一步都用得上：

💡 条目内部有个小巧思：论文引用全部收进<details>折叠块里，列表页面因此保持清爽。写条目时请沿用这个惯例。

三条参与通道：新增工具走哪条？

按 CONTRIBUTING.md 的说法，向 HiC_tools 参与共建有三条路 🛤️：

1. 开 Issue—— 提建议、报勘误都可以放这里；
2. 提 Pull Request—— 直接提交改动，是新增工具的主路径；
3. 联系维护者—— 通过邮件或社交平台沟通细节。

如果目的是收录一款新工具，推荐先开 Issue 讨论、确认归属章节后再提 PR。提前把「这个工具算 Pipelines 还是 QC」这类问题问清楚，能大幅降低返工概率。

准备工作：克隆仓库，顺手把仪表盘跑起来

git clone https://link.gitcode.com/i/45c682530e521ce292f5235dcf6e4fac

克隆下来后可以直接编辑文档；另外建议把本地仪表盘跑起来辅助校验（可选）：

bash run_dashboard.sh

依赖很轻，requirements.txt 里只有 streamlit 和 pandas 两个包。边改边看渲染效果，比盲改再返工要省事得多。

撰写新条目：四个环节走一遍

整个 PR 流程可以拆成四个环节，顺序执行即可。

第一步：查重

在 README.md 里全局搜索工具名。工具库收录已久，重名或同项目改名的情况并不少见，确认不存在同物异名的条目再继续。

第二步：定位章节

翻到 README 顶部的 Table of content，按工具的核心功能找到对应小节——做比对归 Pipelines、做质控归 QC、做 TAD 检测归 TAD callers，做图谱展示归 Visualization。拿不准时，正好用上前面说的「先开 Issue」环节。

第三步：定好插入位置

排序规则只有一条，但必须遵守：

• 已发表工具：按论文发表时间排列，最新的在最上方；
• 未发表工具：统一放到所在章节的末尾。

提交前再确认一次所在章节当前的排序方式，插错位置是新手最常踩的坑。

第四步：按统一格式写下条目

一个标准条目 = 列表项 + 工具链接 + 一两句功能描述 + 可折叠的文献引用。模板如下：

- 工具名 - 一两句功能描述：解决什么问题、输入输出格式、运行平台、安装方式。 <details> <summary>Paper</summary> 作者列表. "论文标题" DOI 链接 期刊, 年份 </details>

几点书写建议：

• 工具链接：指向官网或其代码仓库，二选一即可；
• 功能描述：对齐库内现有条目的风格，突出核心能力、支持的数据格式（如.hic/.cool）、性能优势与运行平台；
• 流水线类工具：描述维度可对照 pipeline_comparison.csv 里的字段（Mapping、Filtering、QC、Contact map、Visualization 等）来组织，信息更完整；
• 文献折叠块：作者、标题、DOI、期刊、年份五要素写全，保持页面整洁的同时方便读者溯源。

发布前自查：六项打勾再按提交

提 PR 之前，对照下面这张清单逐项确认 ✅：

• 已搜索确认无重复条目
• 放进了正确的功能章节
• 已发表工具按发表时间插入、未发表工具放在章节末尾
• 文献信息收进<details>折叠块且包含 DOI
• 本地仪表盘或 Markdown 预览渲染正常
• PR 描述里写明了改动的章节与工具名

全部打勾后就可以发出 PR 了。PR 描述不用写很长，说清楚「新增了哪个章节下的哪个工具」即可，方便维护者快速评审。

写在最后

HiC_tools 对社区贡献者始终敞开大门——从一条 Issue 到一个规范的条目，门槛并不高。挑一款你日常分析 Hi-C 数据时最常用的工具，按这份流程发出去，就是工具库下一个被点开的名字 🧬

【免费下载链接】awesome-public-datasetsA topic-centric list of HQ open datasets.项目地址: https://gitcode.com/GitHub_Trending/aw/awesome-public-datasets