open-webui/Fu-Jie_openwebui-extensions
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: enforce English-only for commit messages and release notes

Browse Source
This commit is contained in:
fujie
2026-02-07 12:38:46 +08:00
parent f882997337
commit 89a12a4fe8
1 changed files with 15 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
.agent/workflows/plugin-development.md
View File

@@ -11,6 +11,7 @@ This workflow outlines the standard process for developing, documenting, and rel
Reference: `.github/copilot-instructions.md` Reference: `.github/copilot-instructions.md`
### Bilingual Requirement ### Bilingual Requirement
Every plugin **MUST** have bilingual versions for both code and documentation: Every plugin **MUST** have bilingual versions for both code and documentation:
- **Code**: - **Code**:
@@ -21,6 +22,7 @@ Every plugin **MUST** have bilingual versions for both code and documentation:
- Chinese: `plugins/{type}/{name}/README_CN.md` - Chinese: `plugins/{type}/{name}/README_CN.md`
### Code Structure ### Code Structure
- **Docstring**: Must include `title`, `author`, `version`, `description`, etc. - **Docstring**: Must include `title`, `author`, `version`, `description`, etc.
- **Valves**: Use `pydantic` for configuration. - **Valves**: Use `pydantic` for configuration.
- **Database**: Re-use `open_webui.internal.db` shared connection. - **Database**: Re-use `open_webui.internal.db` shared connection.
@@ -32,8 +34,9 @@ Every plugin **MUST** have bilingual versions for both code and documentation:
- Use Chat Persistence API for database storage - Use Chat Persistence API for database storage
- Always update both `messages[]` and `history.messages` - Always update both `messages[]` and `history.messages`
### Commit Messages ### Commit Messages & Release Notes
- **Language**: **English ONLY**. Do not use Chinese in commit messages.
- **Language**: **English ONLY**. Do not use Chinese in commit messages or release notes.
- **Format**: Conventional Commits (e.g., `feat:`, `fix:`, `docs:`). - **Format**: Conventional Commits (e.g., `feat:`, `fix:`, `docs:`).
## 2. Documentation Updates ## 2. Documentation Updates
@@ -41,10 +44,12 @@ Every plugin **MUST** have bilingual versions for both code and documentation:
When adding or updating a plugin, you **MUST** update the following documentation files to maintain consistency: When adding or updating a plugin, you **MUST** update the following documentation files to maintain consistency:
### Plugin Directory ### Plugin Directory
- `README.md`: Update version, description, and usage. **Explicitly describe new features in a prominent position at the beginning.** - `README.md`: Update version, description, and usage. **Explicitly describe new features in a prominent position at the beginning.**
- `README_CN.md`: Update version, description, and usage. **Explicitly describe new features in a prominent position at the beginning.** - `README_CN.md`: Update version, description, and usage. **Explicitly describe new features in a prominent position at the beginning.**
### Global Documentation (`docs/`) ### Global Documentation (`docs/`)
- **Index Pages**: - **Index Pages**:
- `docs/plugins/{type}/index.md`: Add/Update list item with **correct version**. - `docs/plugins/{type}/index.md`: Add/Update list item with **correct version**.
- `docs/plugins/{type}/index.zh.md`: Add/Update list item with **correct version**. - `docs/plugins/{type}/index.zh.md`: Add/Update list item with **correct version**.
@@ -53,6 +58,7 @@ When adding or updating a plugin, you **MUST** update the following documentatio
- `docs/plugins/{type}/{name}.zh.md`: Ensure content matches README_CN. - `docs/plugins/{type}/{name}.zh.md`: Ensure content matches README_CN.
### Root README ### Root README
- `README.md`: Add to "Featured Plugins" if applicable. - `README.md`: Add to "Featured Plugins" if applicable.
- `README_CN.md`: Add to "Featured Plugins" if applicable. - `README_CN.md`: Add to "Featured Plugins" if applicable.
@@ -61,6 +67,7 @@ When adding or updating a plugin, you **MUST** update the following documentatio
Reference: `.github/workflows/release.yml` Reference: `.github/workflows/release.yml`
### Version Bumping ### Version Bumping
- **Rule**: Version bump is required **ONLY when the user explicitly requests a release**. Regular code changes do NOT require version bumps. - **Rule**: Version bump is required **ONLY when the user explicitly requests a release**. Regular code changes do NOT require version bumps.
- **Format**: Semantic Versioning (e.g., `1.0.0` -> `1.0.1`). - **Format**: Semantic Versioning (e.g., `1.0.0` -> `1.0.1`).
- **When to Bump**: Only update the version when: - **When to Bump**: Only update the version when:
@@ -78,13 +85,14 @@ Reference: `.github/workflows/release.yml`
8. Docs Detail CN (`docs/.../{name}.zh.md`) 8. Docs Detail CN (`docs/.../{name}.zh.md`)
### Automated Release Process ### Automated Release Process
1. **Trigger**: Push to `main` branch with changes in `plugins/**/*.py`.
2. **Detection**: `scripts/extract_plugin_versions.py` detects changed plugins and compares versions. 1. **Trigger**: Push to `main` branch with changes in `plugins/**/*.py`.
3. **Release**: 2. **Detection**: `scripts/extract_plugin_versions.py` detects changed plugins and compares versions.
3. **Release**:
- Generates release notes based on changes. - Generates release notes based on changes.
- Creates a GitHub Release tag (e.g., `v2024.01.01-1`). - Creates a GitHub Release tag (e.g., `v2024.01.01-1`).
- Uploads individual `.py` files of **changed plugins only** as assets. - Uploads individual `.py` files of **changed plugins only** as assets.
4. **Market Publishing**: 4. **Market Publishing**:
- Workflow: `.github/workflows/publish_plugin.yml` - Workflow: `.github/workflows/publish_plugin.yml`
- Trigger: Release published. - Trigger: Release published.
- Action: Automatically updates the plugin code and metadata on OpenWebUI.com using `scripts/publish_plugin.py`. - Action: Automatically updates the plugin code and metadata on OpenWebUI.com using `scripts/publish_plugin.py`.
@@ -95,6 +103,7 @@ Reference: `.github/workflows/release.yml`
- Example: `https://github.com/Fu-Jie/awesome-openwebui/blob/main/plugins/filters/folder-memory/README.md` - Example: `https://github.com/Fu-Jie/awesome-openwebui/blob/main/plugins/filters/folder-memory/README.md`
### Pull Request Check ### Pull Request Check
- Workflow: `.github/workflows/plugin-version-check.yml` - Workflow: `.github/workflows/plugin-version-check.yml`
- Checks if plugin files are modified. - Checks if plugin files are modified.
- **Fails** if version number is not updated. - **Fails** if version number is not updated.
@@ -114,5 +123,3 @@ Before committing:
## 5. Git Operations (Agent Rules) ## 5. Git Operations (Agent Rules)
Strictly follow the rules defined in `.github/copilot-instructions.md` → **Git Operations (Agent Rules)** section. Strictly follow the rules defined in `.github/copilot-instructions.md` → **Git Operations (Agent Rules)** section.