docs: further simplify contributing guides to focus on plugin files
This commit is contained in:
@@ -1,32 +1,16 @@
|
||||
# Contributing Guide
|
||||
|
||||
Thank you for your interest in **OpenWebUI Extras**! We welcome all kinds of contributions, including prompts and plugins.
|
||||
Thank you for your interest in **OpenWebUI Extras**!
|
||||
|
||||
## 🚀 Quick Start
|
||||
## 🚀 How to Contribute
|
||||
|
||||
1. **Fork** this repository and clone it to your local machine.
|
||||
2. **Add/Modify** content:
|
||||
- **Prompts**: Place in the corresponding category in `prompts/`.
|
||||
- **Plugins**: Place in the corresponding category in `plugins/` (Actions, Filters, Pipes, Tools).
|
||||
3. **Submit PR**: Submit your changes, and we will review them as soon as possible.
|
||||
1. **Fork** this repository.
|
||||
2. **Add/Modify** the plugin file in the `plugins/` directory.
|
||||
3. **Submit PR**: We will review and merge it.
|
||||
|
||||
## 💡 Plugin Development Tips
|
||||
## 💡 Important
|
||||
|
||||
To ensure your plugin is correctly recognized and published:
|
||||
- Include complete metadata (Frontmatter):
|
||||
```python
|
||||
"""
|
||||
title: Plugin Name
|
||||
author: Your Name
|
||||
version: 0.1.0
|
||||
description: Short description
|
||||
"""
|
||||
```
|
||||
- If updating an existing plugin, remember to **increment the version number** (e.g., `0.1.0` -> `0.1.1`). Our CI will automatically sync it to the OpenWebUI Community.
|
||||
- Ensure your plugin includes complete metadata (title, author, version, description).
|
||||
- If updating an existing plugin, please **increment the version number** (e.g., `0.1.0` -> `0.1.1`) to trigger the auto-update.
|
||||
|
||||
## 🛠️ Simple Guidelines
|
||||
|
||||
- **Keep it Simple**: Clear logic and basic comments are enough.
|
||||
- **Local Testing**: Ensure it works in your OpenWebUI environment before submitting.
|
||||
|
||||
Thank you for your contribution! 🚀
|
||||
Thank you! 🚀
|
||||
|
||||
@@ -1,32 +1,16 @@
|
||||
# 贡献指南
|
||||
|
||||
感谢你对 **OpenWebUI Extras** 感兴趣!我们欢迎任何形式的贡献,无论是提示词还是插件。
|
||||
感谢你对 **OpenWebUI Extras** 感兴趣!
|
||||
|
||||
## 🚀 快速贡献流程
|
||||
## 🚀 贡献流程
|
||||
|
||||
1. **Fork** 本仓库并克隆到本地。
|
||||
2. **修改/添加** 内容:
|
||||
- **提示词**: 放入 `prompts/` 对应分类。
|
||||
- **插件**: 放入 `plugins/` 对应分类(Actions, Filters, Pipes, Tools)。
|
||||
3. **提交 PR**: 提交你的修改,我们会尽快审核。
|
||||
1. **Fork** 本仓库。
|
||||
2. **修改/添加** `plugins/` 目录下的插件文件。
|
||||
3. **提交 PR**: 我们会尽快审核并合并。
|
||||
|
||||
## 💡 插件开发建议
|
||||
## 💡 注意事项
|
||||
|
||||
为了让你的插件能被自动识别和发布,请确保:
|
||||
- 包含完整的元数据(Frontmatter):
|
||||
```python
|
||||
"""
|
||||
title: 插件名称
|
||||
author: 你的名字
|
||||
version: 0.1.0
|
||||
description: 简短描述
|
||||
"""
|
||||
```
|
||||
- 如果是更新已有插件,请记得**增加版本号**(如 `0.1.0` -> `0.1.1`),这样系统会自动同步到 OpenWebUI 社区。
|
||||
|
||||
## 🛠️ 简单规范
|
||||
|
||||
- **好用优先**:代码逻辑清晰,关键地方有简单注释即可。
|
||||
- **本地测试**:提交前请确保在你的 OpenWebUI 环境中能正常运行。
|
||||
- 请确保插件包含完整的元数据(title, author, version, description)。
|
||||
- 如果是更新已有插件,请记得**增加版本号**(如 `0.1.0` -> `0.1.1`),这样系统会自动同步更新。
|
||||
|
||||
再次感谢你的贡献!🚀
|
||||
|
||||
Reference in New Issue
Block a user