如何规范参与dupeguru开发：从Git工作流到贡献全流程指南

如何规范参与dupeguru开发：从Git工作流到贡献全流程指南

【免费下载链接】dupeguruFind duplicate files项目地址: https://gitcode.com/gh_mirrors/du/dupeguru

dupeguru是一款强大的重复文件查找工具，本文将详细介绍如何通过规范的Git工作流和贡献流程参与到这个开源项目中，帮助新手轻松上手贡献代码。

认识dupeguru项目

dupeguru提供了三种不同版本以满足不同用户需求：

dupeguru音乐版(dupeguru ME)logo - 专注于音乐文件重复查找

dupeguru图片版(dupeguru PE)logo - 专为图片文件去重设计

dupeguru标准版(dupeguru SE)logo - 通用文件重复查找解决方案

项目结构概览

项目主要代码组织在以下核心目录：

• core/: 包含核心功能实现，如扫描引擎、文件系统处理等
• qt/: Qt界面相关实现
• hscommon/: 通用工具函数库
• locale/: 国际化相关文件

准备贡献环境

1. 克隆项目仓库

git clone https://gitcode.com/gh_mirrors/du/dupeguru cd dupeguru

2. 安装依赖

pip install -r requirements.txt

Git工作流规范

分支管理策略

dupeguru采用简化的Git Flow工作流：

• master分支：稳定的发布版本
• dev分支：开发分支，新功能在此集成
• 功能分支：从dev分支创建，命名格式为feature/功能名称
• 修复分支：从master分支创建，命名格式为hotfix/问题描述

提交规范详解

项目使用commitlint进行提交信息校验，遵循Conventional Commits规范：

// commitlint.config.js const Configuration = { extends: ['@commitlint/config-conventional'], rules: { 'header-max-length': [2, 'always', 72], 'subject-case': [2, 'always', 'sentence-case'], }, };

提交信息格式：

<类型>[可选作用域]: <描述> [可选正文] [可选脚注]

提交类型：

• feat: 新功能
• fix: 错误修复
• docs: 文档更新
• style: 代码格式调整
• refactor: 代码重构
• test: 添加测试
• chore: 构建过程或辅助工具变动

良好提交示例：

feat(ui): Add dark mode toggle button Implement a toggle switch in settings panel to switch between light and dark themes. Closes #42

代码贡献步骤

1. 创建功能分支

git checkout dev git pull git checkout -b feature/your-feature-name

2. 代码开发与风格检查

项目采用以下代码规范：

• Python代码遵循PEP 8规范
• 使用Black进行代码格式化
• 通过flake8进行代码检查
• 新代码需包含PEP 484类型提示

3. 提交更改

git add . git commit -m "feat: Add new feature description"

4. 提交Pull Request

提交PR需遵循以下原则：

1. 每个PR专注于一个功能或修复
2. 确保所有状态检查通过
3. 提供清晰的PR描述，说明实现的功能或修复的问题

其他贡献方式

报告Bug

发现bug时，请提交包含以下信息的issue：

• 复现步骤
• 预期行为
• 实际行为
• 环境信息（操作系统、dupeguru版本等）

本地化贡献

项目支持多语言，本地化文件位于locale/目录下，你可以通过更新对应语言的.po文件为项目添加新的语言支持或改进现有翻译。

文档改进

项目文档主要位于help/目录下，如果你发现文档错误或有改进建议，欢迎提交PR进行修复和完善。

贡献者注意事项

• 所有代码贡献需遵循项目的贡献指南
• 新功能建议在提交代码前先创建issue进行讨论
• 对于标记为beginner的issue是新手入门的理想选择

通过遵循这些规范和流程，你可以顺利地为dupeguru项目做出贡献，无论是代码、文档还是翻译，每一份贡献都将帮助dupeguru变得更好！ 🚀

【免费下载链接】dupeguruFind duplicate files项目地址: https://gitcode.com/gh_mirrors/du/dupeguru