docs: split contributing guide into English and Chinese and remove docs requirement
This commit is contained in:
@@ -1,6 +1,6 @@
|
|||||||
# Contributing Guide
|
# Contributing Guide
|
||||||
|
|
||||||
Thank you for your interest in **OpenWebUI Extras**! We welcome all kinds of contributions, including prompts, plugins, and documentation improvements.
|
Thank you for your interest in **OpenWebUI Extras**! We welcome all kinds of contributions, including prompts and plugins.
|
||||||
|
|
||||||
## 🚀 Quick Start
|
## 🚀 Quick Start
|
||||||
|
|
||||||
@@ -28,34 +28,5 @@ To ensure your plugin is correctly recognized and published:
|
|||||||
|
|
||||||
- **Keep it Simple**: Clear logic and basic comments are enough.
|
- **Keep it Simple**: Clear logic and basic comments are enough.
|
||||||
- **Local Testing**: Ensure it works in your OpenWebUI environment before submitting.
|
- **Local Testing**: Ensure it works in your OpenWebUI environment before submitting.
|
||||||
- **Docs**: For complex features, adding a simple guide in `docs/` is recommended.
|
|
||||||
|
|
||||||
---
|
Thank you for your contribution! 🚀
|
||||||
|
|
||||||
# 贡献指南
|
|
||||||
|
|
||||||
感谢你对 **OpenWebUI Extras** 感兴趣!我们欢迎任何形式的贡献,无论是提示词、插件还是文档改进。
|
|
||||||
|
|
||||||
## 🚀 快速贡献流程
|
|
||||||
|
|
||||||
1. **Fork** 本仓库并克隆到本地。
|
|
||||||
2. **修改/添加** 内容:
|
|
||||||
- **提示词**: 放入 `prompts/` 对应分类。
|
|
||||||
- **插件**: 放入 `plugins/` 对应分类(Actions, Filters, Pipes, Tools)。
|
|
||||||
3. **提交 PR**: 提交你的修改,我们会尽快审核。
|
|
||||||
|
|
||||||
## 💡 插件开发建议
|
|
||||||
|
|
||||||
为了让你的插件能被自动识别和发布,请确保:
|
|
||||||
- 包含完整的元数据(Frontmatter):
|
|
||||||
```python
|
|
||||||
"""
|
|
||||||
title: 插件名称
|
|
||||||
author: 你的名字
|
|
||||||
version: 0.1.0
|
|
||||||
description: 简短描述
|
|
||||||
"""
|
|
||||||
```
|
|
||||||
- 如果是更新已有插件,请记得**增加版本号**(如 `0.1.0` -> `0.1.1`),这样系统会自动同步到 OpenWebUI 社区。
|
|
||||||
|
|
||||||
再次感谢你的贡献!🚀
|
|
||||||
|
|||||||
32
CONTRIBUTING_CN.md
Normal file
32
CONTRIBUTING_CN.md
Normal file
@@ -0,0 +1,32 @@
|
|||||||
|
# 贡献指南
|
||||||
|
|
||||||
|
感谢你对 **OpenWebUI Extras** 感兴趣!我们欢迎任何形式的贡献,无论是提示词还是插件。
|
||||||
|
|
||||||
|
## 🚀 快速贡献流程
|
||||||
|
|
||||||
|
1. **Fork** 本仓库并克隆到本地。
|
||||||
|
2. **修改/添加** 内容:
|
||||||
|
- **提示词**: 放入 `prompts/` 对应分类。
|
||||||
|
- **插件**: 放入 `plugins/` 对应分类(Actions, Filters, Pipes, Tools)。
|
||||||
|
3. **提交 PR**: 提交你的修改,我们会尽快审核。
|
||||||
|
|
||||||
|
## 💡 插件开发建议
|
||||||
|
|
||||||
|
为了让你的插件能被自动识别和发布,请确保:
|
||||||
|
- 包含完整的元数据(Frontmatter):
|
||||||
|
```python
|
||||||
|
"""
|
||||||
|
title: 插件名称
|
||||||
|
author: 你的名字
|
||||||
|
version: 0.1.0
|
||||||
|
description: 简短描述
|
||||||
|
"""
|
||||||
|
```
|
||||||
|
- 如果是更新已有插件,请记得**增加版本号**(如 `0.1.0` -> `0.1.1`),这样系统会自动同步到 OpenWebUI 社区。
|
||||||
|
|
||||||
|
## 🛠️ 简单规范
|
||||||
|
|
||||||
|
- **好用优先**:代码逻辑清晰,关键地方有简单注释即可。
|
||||||
|
- **本地测试**:提交前请确保在你的 OpenWebUI 环境中能正常运行。
|
||||||
|
|
||||||
|
再次感谢你的贡献!🚀
|
||||||
@@ -105,4 +105,4 @@ OpenWebUI 增强功能集合。包含个人开发与收集的插件、提示词
|
|||||||
2. 将你的文件添加到对应的 `prompts/` 或 `plugins/` 目录。
|
2. 将你的文件添加到对应的 `prompts/` 或 `plugins/` 目录。
|
||||||
3. 提交 Pull Request。
|
3. 提交 Pull Request。
|
||||||
|
|
||||||
[贡献指南](./CONTRIBUTING.md) | [更新日志](./CHANGELOG.md)
|
[贡献指南](./CONTRIBUTING_CN.md) | [更新日志](./CHANGELOG.md)
|
||||||
|
|||||||
Reference in New Issue
Block a user