Skip to content

Commit 8cfc262

Browse files
authored
Merge pull request #10 from yinxulai/upload_tools
docs: add comprehensive contribution guidelines to README
2 parents ee0a8d7 + 8574ca6 commit 8cfc262

File tree

1 file changed

+78
-0
lines changed

1 file changed

+78
-0
lines changed

README.md

Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -121,6 +121,84 @@ pip install -r requirements.txt
121121
python -m main
122122
```
123123

124+
## 贡献指南
125+
126+
我们欢迎社区贡献!以下是参与贡献的几种方式:
127+
128+
### 🙏 贡献者
129+
130+
感谢所有为这个项目做出贡献的开发者:
131+
132+
<a href="https://github.com/qiniu/dify-plugin/graphs/contributors">
133+
<img src="https://contrib.rocks/image?repo=qiniu/dify-plugin" alt="贡献者" />
134+
</a>
135+
136+
*[contrib.rocks](https://contrib.rocks) 自动生成*
137+
138+
### 🐛 报告 Bug
139+
140+
如果你发现了 Bug,请通过以下方式报告:
141+
142+
1. **检查已有 Issues**:在提交新 Issue 前,请先检查 [Issues 页面](https://github.com/qiniu/dify-plugin/issues) 是否已有相关问题
143+
2. **提供详细信息**:报告 Bug 时请包含:
144+
- 详细的问题描述
145+
- 复现步骤
146+
- 预期行为 vs 实际行为
147+
- 环境信息(操作系统、Python 版本、Dify 版本等)
148+
- 相关的错误日志或截图
149+
150+
### 💡 功能建议
151+
152+
如果你有新功能的想法:
153+
154+
1. 先在 [Issues](https://github.com/qiniu/dify-plugin/issues) 中搜索是否有类似建议
155+
2. 如果没有,创建新的 Issue 并标记为 `enhancement`
156+
3. 详细描述你的想法和使用场景
157+
158+
### 🛠️ 代码贡献
159+
160+
1. **Fork 此仓库**到你的 GitHub 账户
161+
2. **创建功能分支**`git checkout -b feature/your-feature-name`
162+
3. **本地开发**
163+
- 遵循现有的代码风格
164+
- 确保你的更改不会破坏现有功能
165+
- 如果可能,添加相应的测试
166+
4. **提交更改**
167+
- 使用清晰、简洁的提交信息
168+
- 建议使用英文提交信息,格式:`type: description`
169+
- 示例:`feat: add new model support for GLM-5`
170+
5. **推送分支**`git push origin feature/your-feature-name`
171+
6. **创建 Pull Request**
172+
- 在 PR 描述中详细说明你的更改
173+
- 如果 PR 解决了某个 Issue,请在描述中引用:`Fixes #issue-number`
174+
175+
### 📝 文档贡献
176+
177+
文档改进同样重要:
178+
179+
- 修正错别字或不准确的信息
180+
- 补充缺失的文档
181+
- 改进文档结构和可读性
182+
- 翻译文档到其他语言
183+
184+
### 🏷️ Issue 标签说明
185+
186+
为了更好地管理 Issues,我们使用以下标签:
187+
188+
- `bug`:确认的 Bug 报告
189+
- `enhancement`:功能增强或新功能请求
190+
- `documentation`:文档相关的改进
191+
- `good first issue`:适合新贡献者的简单问题
192+
- `help wanted`:需要社区帮助的问题
193+
- `question`:使用问题或询问
194+
195+
### 📞 联系方式
196+
197+
如果你有任何问题或建议,可以通过以下方式联系我们:
198+
199+
- 在 GitHub 上创建 [Issue](https://github.com/qiniu/dify-plugin/issues)
200+
- 通过 GitHub Discussions 参与讨论
201+
124202
## 许可证
125203

126204
本项目采用 MIT 开源许可证,具体详情请查看 LICENSE 文件。

0 commit comments

Comments
 (0)