Files

copilot-swe-agent[bot] ba44dfab26 docs: add full zh translations for site

Co-authored-by: Fu-Jie <33599649+Fu-Jie@users.noreply.github.com>

2025-12-30 01:22:29 +00:00

3.6 KiB

Raw Blame History

贡献指南

感谢你对 OpenWebUI Extras 的兴趣！我们欢迎各种形式的贡献，包括插件、提示词、文档等。

🤝 如何贡献

1. 分享提示词

如果你有实用的提示词想要分享：

浏览 prompts/ 目录并找到合适的分类
如果没有合适的分类，可以新建一个文件夹
创建一个新的 .md 文件来编写你的提示词
提交 Pull Request

提示词格式

# 提示词名称

简短描述这个提示词的功能。

## 使用场景

说明何时使用这个提示词。

## 提示词内容

\```text
你的提示词内容...
\```

## 使用技巧

使用这个提示词的一些建议和技巧。

2. 开发插件

如果你开发了一个 OpenWebUI 插件：

插件元数据

确保你的插件包含完整的元数据：

"""
title: 插件名称
author: 你的名字
version: 0.1.0
description: 简短描述插件的功能
"""

目录结构

将插件放在合适的目录下：

plugins/actions/ - Action 插件（消息下方的按钮）
plugins/filters/ - Filter 插件（消息处理）
plugins/pipes/ - Pipe 插件（自定义模型）
plugins/pipelines/ - Pipeline 插件（复杂工作流）

文档

请为你的插件提供文档：

README.md - 英文文档
README_CN.md - 中文文档（可选但推荐）

文档应包含：

功能描述
安装步骤
配置选项
使用示例
故障排除指南

3. 改进文档

发现错误或想要改进文档？

Fork 仓库
在 docs/ 目录下进行修改
提交 Pull Request

🛠️ 开发规范

代码风格

Python：遵循 PEP 8 规范
注释：为复杂逻辑添加注释
命名：使用清晰、描述性的名称

测试

提交前请确保：

在本地 OpenWebUI 环境中测试插件
验证所有功能按文档所述正常工作
检查边界情况和错误处理

提交信息

使用清晰、描述性的提交信息：

Add: 智能思维导图 action 插件
Fix: 上下文压缩 token 计数问题
Update: 插件开发指南添加新示例

📝 提交 Pull Request

详细步骤

Fork 本仓库
克隆你的 fork 到本地

创建新分支：

git checkout -b feature/amazing-feature

进行修改
提交你的修改：
```
git commit -m 'Add: Amazing feature'
```

推送到你的分支：

git push origin feature/amazing-feature

创建 Pull Request

PR 检查清单

代码遵循项目风格指南
包含/更新了文档
插件已在本地测试通过
提交信息清晰
PR 描述说明了所做的更改

🐛 报告问题

发现了 bug？请创建 issue 并包含以下信息：

描述：清晰描述问题
复现步骤：如何触发这个问题
预期行为：应该发生什么
实际行为：实际发生了什么
环境信息：OpenWebUI 版本、浏览器、操作系统

💡 功能请求

有新想法？我们很乐意听取！

先检查是否已有类似的 issue
创建新 issue 并添加 "enhancement" 标签
描述你的想法和使用场景

📄 许可证

通过贡献，你同意你的贡献将使用与项目相同的许可证。

🙏 感谢

每一份贡献，无论大小，都有助于让 OpenWebUI Extras 变得更好。感谢你成为我们社区的一员！

:fontawesome-brands-github: 在 GitHub 上查看{ .md-button .md-button--primary }

3.6 KiB Raw Blame History Unescape Escape