76 lines
1.3 KiB
Markdown
76 lines
1.3 KiB
Markdown
|
# 参与贡献
|
|||
|
|
|
|||
|
|
感谢所有贡献者的支持！
|
|||
|
|
|
|||
|
|
<a href="https://github.com/xerrors/Yuxi-Know/contributors">
|
|||
|
|
<img src="https://contributors.nn.ci/api?repo=xerrors/Yuxi-Know" alt="贡献者名单">
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
## 如何贡献
|
|||
|
|
|
|||
|
|
### 1. Fork 项目
|
|||
|
|
|
|||
|
|
在 GitHub 上 Fork 本项目到你的账户。
|
|||
|
|
|
|||
|
|
### 2. 创建分支
|
|||
|
|
|
|||
|
|
```bash
|
|||
|
|
git checkout -b feature/amazing-feature
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
### 3. 提交更改
|
|||
|
|
|
|||
|
|
```bash
|
|||
|
|
git commit -m 'feat: Add some amazing feature'
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
### 4. 推送分支
|
|||
|
|
|
|||
|
|
```bash
|
|||
|
|
git push origin feature/amazing-feature
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
### 5. 创建 PR
|
|||
|
|
|
|||
|
|
在 GitHub 上创建 Pull Request，详细描述你的更改内容。
|
|||
|
|
|
|||
|
|
## 开发指南
|
|||
|
|
|
|||
|
|
### 代码规范
|
|||
|
|
|
|||
|
|
- 遵循项目代码规范
|
|||
|
|
- Python 代码使用 `make format` 格式化
|
|||
|
|
- 使用 `make lint` 检查代码质量
|
|||
|
|
- 添加必要的测试用例
|
|||
|
|
- 更新相关文档
|
|||
|
|
|
|||
|
|
### 提交规范
|
|||
|
|
|
|||
|
|
使用清晰的提交信息：
|
|||
|
|
|
|||
|
|
```
|
|||
|
|
feat: 添加新功能
|
|||
|
|
fix: 修复 bug
|
|||
|
|
docs: 更新文档
|
|||
|
|
style: 代码格式调整
|
|||
|
|
refactor: 代码重构
|
|||
|
|
test: 添加测试
|
|||
|
|
chore: 构建过程或辅助工具的变动
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
### 测试要求
|
|||
|
|
|
|||
|
|
::: info
|
|||
|
|
部分测试脚本待补充
|
|||
|
|
:::
|
|||
|
|
|
|||
|
|
- 确保所有测试通过
|
|||
|
|
- 添加新功能的测试用例
|
|||
|
|
- 验证现有功能不受影响
|
|||
|
|
- 测试不同环境下的兼容性
|
|||
|
|
|
|||
|
|
## 许可证
|
|||
|
|
|
|||
|
|
本项目基于 MIT License 开源，贡献的代码将遵循相同的许可证。
|
|||
|
|
|