PDM项目开发环境搭建与贡献指南

PDM项目开发环境搭建与贡献指南

pdm A modern Python package and dependency manager supporting the latest PEP standards 项目地址: https://gitcode.com/gh_mirrors/pd/pdm

前言

PDM作为现代Python包管理工具，其开发流程遵循了Python生态的最佳实践。本文将详细介绍如何搭建PDM的开发环境，以及如何规范地参与项目贡献。无论你是想修复bug、添加新功能，还是改进文档，本文都将为你提供完整的指导。

开发环境准备

虚拟环境配置

建议使用Python内置的venv模块创建隔离的开发环境：

python -m venv .venv

激活环境：

• Linux/macOS: source .venv/bin/activate
• Windows: .venv/Scripts/activate

安装开发依赖

确保pip版本足够新（≥21.3），然后以可编辑模式安装PDM：

python -m pip install -U "pip>=21.3"
python -m pip install -e .

配置PDM使用当前虚拟环境：

pdm config python.use_venv true
pdm config venv.in_project true

安装完整的开发依赖项：

pdm install

代码开发规范

测试运行

PDM使用pytest作为测试框架，可以通过以下命令运行测试：

pdm run test

为提高测试效率，可使用pytest-xdist并行运行：

pdm run test -n auto

代码风格检查

PDM采用以下工具保证代码质量：

• black：代码格式化
• isort：导入排序
• pre-commit：Git钩子管理

安装pre-commit并初始化：

python -m pip install pre-commit
pre-commit install

手动运行代码检查：

pdm run lint

变更记录规范

任何代码变更都需要添加对应的变更记录片段，这些文件存放在news/目录下，命名格式为：<issue编号>.<变更类型>.md

支持的变更类型包括：

• feature：新功能
• bugfix：错误修复
• refactor：代码重构
• doc：文档更新
• dep：依赖变更
• removal：API移除
• misc：其他变更

变更描述应使用祈使语气，例如："修复插件列表重复问题"。

文档开发

文档开发需要额外依赖：

sudo apt install libffi-dev

本地预览文档：

pdm run doc

版本发布流程

在main分支上执行发布前检查：

pdm run release --dry-run

确认无误后执行正式发布：

pdm run release

发布命令会自动处理版本号更新、变更日志生成等流程。

最佳实践建议

1. 保持main分支与上游同步，开发新功能时创建独立分支
2. 提交前确保通过所有测试和代码检查
3. 为每个功能或修复编写清晰的变更记录
4. 复杂变更建议先创建issue讨论方案

通过遵循这些规范，你可以高效地为PDM项目做出贡献，同时保证代码质量和项目一致性。

pdm A modern Python package and dependency manager supporting the latest PEP standards 项目地址: https://gitcode.com/gh_mirrors/pd/pdm