Skip to content

Commit 6afe864

Browse files
committed
docs: add contributing guidelines to README files, enhancing community contribution process and code quality checks
1 parent 4cb7559 commit 6afe864

File tree

2 files changed

+56
-0
lines changed

2 files changed

+56
-0
lines changed

README.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -172,3 +172,31 @@ Example workflow JSON files are provided in the `examples/` directory:
172172
- `wan_i2v.json` - Basic image-to-video
173173
- `wan_i2v_with_distill_lora.json` - I2V with distillation LoRA
174174
- `wan_t2v_with_distill_lora.json` - T2V with distillation LoRA
175+
176+
## Contributing Guidelines
177+
178+
We welcome community contributions! Before submitting code, please ensure you follow these steps:
179+
180+
### Install Development Dependencies
181+
182+
```bash
183+
pip install ruff pre-commit
184+
```
185+
186+
### Code Quality Check
187+
188+
Before committing code, run the following command:
189+
190+
```bash
191+
pre-commit run --all-files
192+
```
193+
194+
This will automatically check code formatting, syntax errors, and other code quality issues.
195+
196+
### Contribution Process
197+
198+
1. Fork this repository
199+
2. Create a feature branch (`git checkout -b feature/amazing-feature`)
200+
3. Commit your changes (`git commit -m 'Add some amazing feature'`)
201+
4. Push to the branch (`git push origin feature/amazing-feature`)
202+
5. Create a Pull Request

README_CN.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -172,3 +172,31 @@ ComfyUI/models/lightx2v/
172172
- `wan_i2v.json` - 基础图像生成视频
173173
- `wan_i2v_with_distill_lora.json` - 带蒸馏 LoRA 的 I2V
174174
- `wan_t2v_with_distill_lora.json` - 带蒸馏 LoRA 的 T2V
175+
176+
## 贡献指南
177+
178+
我们欢迎社区贡献!在提交代码之前,请确保遵循以下步骤:
179+
180+
### 安装开发依赖
181+
182+
```bash
183+
pip install ruff pre-commit
184+
```
185+
186+
### 代码质量检查
187+
188+
在提交代码之前,请运行以下命令:
189+
190+
```bash
191+
pre-commit run --all-files
192+
```
193+
194+
这将自动检查代码格式、语法错误和其他代码质量问题。
195+
196+
### 贡献流程
197+
198+
1. Fork 本仓库
199+
2. 创建功能分支 (`git checkout -b feature/amazing-feature`)
200+
3. 提交更改 (`git commit -m 'Add some amazing feature'`)
201+
4. 推送到分支 (`git push origin feature/amazing-feature`)
202+
5. 创建 Pull Request

0 commit comments

Comments
 (0)