docs: update plugin development standards for readme requirements

This commit is contained in:
fujie
2026-01-03 12:37:05 +08:00
parent 3795976a79
commit 40d77121bd
2 changed files with 4 additions and 2 deletions

View File

@@ -35,8 +35,8 @@ 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. - `README.md`: Update version, description, and usage. **Explicitly describe new features.**
- `README_CN.md`: Update version, description, and usage. - `README_CN.md`: Update version, description, and usage. **Explicitly describe new features.**
### Global Documentation (`docs/`) ### Global Documentation (`docs/`)
- **Index Pages**: - **Index Pages**:

View File

@@ -37,7 +37,9 @@ README 文件应包含以下内容:
- 安装和设置说明 / Installation and setup instructions - 安装和设置说明 / Installation and setup instructions
- 使用示例 / Usage examples - 使用示例 / Usage examples
- 故障排除指南 / Troubleshooting guide - 故障排除指南 / Troubleshooting guide
- 故障排除指南 / Troubleshooting guide
- 版本和作者信息 / Version and author information - 版本和作者信息 / Version and author information
- **新增功能 / New Features**: 如果是更新现有插件,必须明确列出并描述新增功能(发布到官方市场的重要要求)。/ If updating an existing plugin, explicitly list and describe new features (Critical for official market release).
### 官方文档 (Official Documentation) ### 官方文档 (Official Documentation)