企业官网建设流程全解析

HiC_tools 新手贡献指南：向 HiC_tools 提交新工具快速上手

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

HiC_tools 是收录数百个 Hi-C 分析工具的开源库。这篇 Hi-C 工具库贡献指南，把向 HiC_tools 提交工具拆成挑入口、写条目、发 PR 三步，照着做就能发出你的第一条贡献。

向 HiC_tools 提交工具时可参考的 3C/Hi-C 技术对比表

🗺️ HiC_tools 仓库地图：6 个关键文件速览

写条目之前，先花三分钟认清楚仓库里的分工，后面找文件就不会迷路。

还有一条规则直接决定你的条目放在哪：章节内已发表工具按论文发表时间倒序排列，最新在最上方；未发表工具统一放在章节末尾。提交前先看一眼所在小节的既有顺序。

🚪 挑贡献入口：三种方式，选最轻的一条

工具库提供三条贡献路径：

1. 开一个 Issue——用于建议、勘误，或提交前的讨论；
2. 直接提 PR——新增工具的主路径，改动直接落在仓库里；
3. 联系维护者——通过邮件或社交平台沟通，适合不便写成 PR 的问题。

建议新增工具先开 Issue 确认工具归入哪个章节，再提 PR。章节一次判断对，能省掉一轮返工。

克隆仓库与本地预览仪表盘

先拿到仓库的本地副本，后续改动都在本地完成：

git clone https://gitcode.com/GitHub_Trending/aw/awesome-public-datasets

条目写完想确认渲染效果，启动本地仪表盘即可：

bash run_dashboard.sh

依赖很轻，requirements.txt只列了 streamlit 和 pandas 两个包。

✍️ HiC_tools 工具条目模板拆解

一条标准条目由四部分组成：列表项、工具链接、一两句功能描述、<details>折叠文献块。

结构上：第一行是列表项，写工具名加功能描述，工具名链接到官网或代码仓库；描述之后接<details>标签，<summary>里写 Paper，块内给出作者列表、论文标题、DOI 链接、期刊和年份。折叠后列表页保持整洁，需要文献的人点开即可。

书写要点有四条：

• 工具链接：指向工具官网或代码仓库，方便读者直达；
• 功能描述：参照库内现有条目风格，突出核心能力、支持的数据格式（.hic、.cool 等）与性能优势；
• 折叠块：作者、标题、DOI、期刊、年份写全，不省略；
• 流水线类工具：对照pipeline_comparison.csv的功能维度（Mapping、Filtering、QC、Contact map、Visualization 等）组织描述，评审能快速判断能力边界。

提交前清单：从查重要到发 PR

这条动线覆盖了 HiC_tools PR 流程的全部要点，逐项打勾：

• 在README.md中按工具名检索过，确认没有重复条目
• 定位到所属功能章节，并核对该章节的排序方式
• 已发表工具按发表时间倒序插入，未发表的放在章节末尾
• 条目按模板写就，<details>折叠块内含完整文献
• 本地仪表盘打开过，渲染效果正常
• PR 描述里写明了改动的章节与工具名

PR 描述是评审第一眼看到的内容，把改了哪些章节、动了哪个工具说清楚，审核才能直奔主题。

如果你手里有一款常用来跑 Hi-C 数据的分析工具，它就是最好的第一批提交素材——提交到 HiC_tools，让同行都用上 ✨

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