# 贡献指南 ## 开发环境 为了确保一致的开发环境,我们强烈建议使用提供的 Dev Container。这将设置一个容器化的环境,预先安装所有必要的工具和依赖项。 1. 安装 [Docker](https://www.docker.com/products/docker-desktop/)。 2. 在 Visual Studio Code 中安装 [Dev Containers extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers)。 3. 在 VS Code 中打开项目。当被提示时,点击“在容器中重新打开”以启动开发容器。 ## 依赖管理 该项目使用 `uv` 进行快速高效的 Python 包管理。 要安装依赖项,请在终端中运行以下命令: ```bash uv sync ``` ## 代码质量和代码检查 我们使用 `pre-commit` 在提交之前执行代码质量标准。这确保所有代码都通过 `ruff`(用于代码检查和格式化)和 `pyright`(用于类型检查)的检查。 ### 设置 要设置 `pre-commit`,请运行以下命令: ```bash pre-commit install ``` 这将安装 pre-commit 钩子,每次提交时会自动运行。如果任何检查失败,提交将被中止。您需要修复报告的问题并暂存更改,然后再尝试提交。 ## 提交信息指南 我们遵循 [AngularJS 提交规范](https://github.com/angular/angular.js/blob/master/DEVELOPERS.md#commit-message-format) 来编写提交信息。这使得在查看项目历史记录时,信息更加可读且易于理解。 每条提交信息由 **标题**、**主体**和 **页脚** 三部分组成。 ``` ():