# 贡献者指南
首先感谢你愿意为 Paline 贡献代码!🎉
请花几分钟阅读以下指南,确保你的贡献流程顺畅。
## 开发环境准备
- **Rust 工具链**:需要 `rustc` 1.88 或更高版本。
- **Git**:用于版本控制。
- **Python 3.7+**(仅用于运行提交前检查脚本,非必需,但推荐)。
### 克隆仓库并构建:
```bash
git clone https://github.com/luxpapilio/paline.git
cd paline
cargo build
```
## 提交前检查(Pre-commit)
本项目在 `scripts/` 目录下提供了 `push.py` 脚本,用于在推送前自动运行测试、格式化。
### 脚本环境搭建
```bash
#在项目根目录下运行
python3 -m venv .venv
source "./.venv/bin/activate" # Linux/macOS
# .\.venv\Scripts\activate # Windows (PowerShell)
pip install -r requirements-dev.txt
```
### 运行方式
```bash
# 确保你有 Python 3.x 环境并且已激活虚拟环境(如果还没激活,先执行上面的激活命令)
python scripts/push.py
```
再次感谢你的贡献!