dev_zh.md

开发指南

English | 中文 | 日本語 | Español | 한국어

1. 代码风格

我们采用 PEP8 作为首选代码风格。

我们使用以下工具进行代码检查和格式化：

• flake8：代码检查（linter）
• yapf：格式化工具
• isort：整理 import 顺序

yapf 和 isort 的样式配置可以在 setup.cfg 中找到。 我们使用 pre-commit hook，在每次提交时自动检查并格式化 flake8、yapf、seed-isort-config、isort、trailing whitespaces， 修复 end-of-files，并自动整理 requirements.txt。 pre-commit hook 的配置存放在 .pre-commit-config 中。 克隆仓库后，你需要安装并初始化 pre-commit hook。

pip install -r requirements-test.txt

在仓库根目录下执行：

pre-commit install

完成以上步骤后，每次提交都会自动执行代码检查和格式化。

如果你想对所有文件运行 pre-commit 检查，可以执行：

pre-commit run --all-files