贡献指南

开发环境搭建

# 克隆仓库
git clone git@github.com:LessUp/fastq-tools.git
cd fastq-tools
# 安装依赖
./scripts/core/install-deps
# 构建
./scripts/core/build
# 测试
./scripts/core/test

Git 提交规范

提交格式

<type>(<scope>): <subject>

Type 类型

Scope 范围(可选)

Subject 规则

示例

feat(parser): add BAM file input support
fix(core): correct GC content calculation
docs(readme): update installation instructions
refactor(pipeline): simplify processing loop
perf(io): optimize buffer allocation
ci(github): add automated linting

提交信息模板

# 启用仓库内模板
git config commit.template .gitmessage.txt
# Dev Container 会自动设置该配置

开发流程

1. 创建功能分支

git checkout -b feat/my-feature

2. 开发与测试

# 编码...
# 格式化
./scripts/core/lint format
# 测试
./scripts/core/test
# 检查代码质量
./scripts/core/lint all

3. 提交

git add .
git commit # 遵循提交规范

4. 推送与 PR

git push origin feat/my-feature
# 在 GitHub 创建 Pull Request

代码审查清单

功能

质量

测试

文档

PR 注意事项

添加新功能检查清单

添加新的过滤谓词

添加新的子命令

发布流程

# 1. 更新版本号
# CMakeLists.txt 和 conanfile.py 中的 version
# 2. 更新 CHANGELOG.md
# 3. 创建 tag
git tag -a v3.2.0 -m "Release v3.2.0"
git push origin v3.2.0
# 4. GitHub Actions 自动触发 release workflow

联系方式

相关页面