khmer开发者手册：贡献代码与扩展功能的完整流程

khmer开发者手册：贡献代码与扩展功能的完整流程

【免费下载链接】khmerIn-memory nucleotide sequence k-mer counting, filtering, graph traversal and more项目地址: https://gitcode.com/gh_mirrors/kh/khmer

khmer是一个高效的核苷酸序列k-mer计数、过滤和图遍历工具，本文将详细介绍如何为该项目贡献代码与扩展功能的完整流程，帮助新手开发者快速上手参与开源贡献。

一、环境准备与项目克隆

1.1 安装必要依赖

在开始贡献前，确保系统已安装以下工具：

• Git
• C++编译器（支持C++11及以上标准）
• Python 3.6+
• 相关依赖库（可参考doc/user/install.rst）

1.2 克隆项目仓库

使用以下命令克隆khmer项目仓库：

git clone https://gitcode.com/gh_mirrors/kh/khmer cd khmer

二、代码库结构解析

2.1 核心目录说明

khmer项目结构清晰，主要包含以下关键目录：

• include/：存放C++和C头文件，核心C++库位于include/oxli，CPython包装器位于include/khmer
• src/：包含所有C++和CPython代码，与include目录结构对应，主CPython模块构建于src/khmer/_cpy_khmer.hh
• khmer/：Python包目录，包含khmer/init.py及实验性Cython绑定khmer/_oxli
• scripts/：存放Python命令行脚本，所有用于已发布分析流程的脚本必须在此目录并通过测试
• sandbox/：包含实验性脚本，无需自动化测试
• tests/：所有测试代码，每个测试是tests/test*.py文件中的一个函数

2.2 构建项目

使用make命令构建项目，包括测试和开发代码：

make

三、贡献代码流程

3.1 创建分支

遵循GitHub Flow工作流，为每个功能或修复创建独立分支：

# 从主分支创建新分支 git checkout master git pull git checkout -b feature/your-feature-name

3.2 代码开发规范

• 命令行脚本：使用短横线命名（如filter-abund.py），遵循scripts/目录中的约定，参考doc/dev/scripts-and-sandbox.rst
• Python/C集成：CPython包装器代码位于src/khmer/_cpy_khmer.cc，使用cpychecker工具检查正确性
• 错误处理：成功退出码为0，一般错误为1，遵循Linux退出码规范
• 读处理：使用khmer/utils.py中的函数进行标准化读处理，如broken_paired_reader和clean_input_reads

3.3 编写测试

所有代码必须包含测试：

• 新功能测试添加到tests/目录下的相应文件
• 脚本测试添加到tests/test_scripts.py
• 确保代码覆盖率不降低，可通过Travis和CodeCov查看覆盖率报告

3.4 提交与拉取请求

• 提交遵循清晰的提交信息规范
• 创建拉取请求（PR）到主仓库的master分支
• 所有PR必须经过代码审查才能合并
• 建议在开发过程中创建"正在进行中"的PR，以便跟踪进度

四、扩展功能指南

4.1 开发新算法

若要实现新的k-mer算法或图遍历功能：

1. 在include/oxli中添加头文件（如new_algorithm.hh）
2. 在src/oxli中实现C++代码
3. 在khmer/_oxli中创建Cython绑定
4. 添加Python API测试到tests/目录

4.2 添加命令行工具

创建新的命令行工具步骤：

1. 在scripts/目录下创建Python脚本
2. 使用khmer/khmer_args.py处理命令行参数
3. 实现核心功能，调用khmer库API
4. 在tests/test_scripts.py中添加测试用例

4.3 链接liboxli库

外部项目可链接khmer的C++库liboxli：

# 安装liboxli make install-liboxli PREFIX=/path/to/install

在外部项目中包含头文件：

#include "oxli/hashgraph.hh"

编译时添加链接选项：-loxli

五、代码审查与合并

5.1 审查要求

• 所有代码必须经过审查才能合并
• 代码覆盖率不得降低
• 遵循项目编码规范
• 测试通过Travis CI构建

5.2 PR处理

• PR应专注于单一功能或修复
• 及时回应审查意见
• 若PR长时间未更新，维护者可在通知原作者后接手继续开发
• 合并前确保所有讨论已解决，测试通过

六、开发资源与支持

6.1 官方文档

• 开发指南
• 代码库指南
• 贡献者指南

6.2 社区支持

• 联系邮箱：khmer-project@idyll.org
• 项目issue跟踪系统

通过以上步骤，您可以顺利地为khmer项目贡献代码和扩展功能。无论是修复bug还是添加新特性，遵循这些流程将确保您的贡献能够被高效地整合到项目中，同时帮助您成为活跃的开源社区成员。

【免费下载链接】khmerIn-memory nucleotide sequence k-mer counting, filtering, graph traversal and more项目地址: https://gitcode.com/gh_mirrors/kh/khmer