From 5caf265a359fae71a168121612287a101782223b Mon Sep 17 00:00:00 2001 From: gitee-bot Date: Fri, 13 Jun 2025 06:11:31 +0000 Subject: [PATCH] Update README.md --- README.en.md | 27 +++++++++++++++++++++++++++ README.md | 27 +++++++++++++++++++++++++++ 2 files changed, 54 insertions(+) create mode 100644 README.en.md create mode 100644 README.md diff --git a/README.en.md b/README.en.md new file mode 100644 index 0000000..2f13471 --- /dev/null +++ b/README.en.md @@ -0,0 +1,27 @@ + + +# Gitee Issue and Pull Request Templates + +This project provides standardized Gitee Issue reporting templates and Pull Request submission templates to help developers streamline code collaboration workflows. + +## Features +- **Issue Template**: Includes key fields like problem description, reproduction steps, and error messages +- **PR Template**: Covers associated Issue, development purpose, specific changes, and test cases + +## Usage Instructions +1. Copy the `.gitee/ISSUE_TEMPLATE.md` file to the `.gitee` directory of your target repository +2. Synchronize the `.gitee/PULL_REQUEST_TEMPLATE.md` file to the `.gitee` directory of your target repository +3. Template content will be automatically generated when submitting Issues or PRs +4. Modify placeholder text in templates according to actual requirements + +## Contribution Guidelines +Please follow these specifications for submissions: +1. Use the ISSUE_TEMPLATE when creating Issues +2. Use the PULL_REQUEST_TEMPLATE when submitting Pull Requests +3. Ensure test cases include: + - Verification cases for new features + - Regression testing for modified features + - Edge cases that may be affected + +## License +This project uses the MIT License. See [MIT License](https://opensource.org/licenses/MIT) documentation for details. \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..43fb819 --- /dev/null +++ b/README.md @@ -0,0 +1,27 @@ + + +# Gitee Issue与Pull Request模板 + +该项目提供了一套标准化的Gitee Issue报告模板和Pull Request提交模板,帮助开发者规范代码协作流程。 + +## 功能特性 +- **Issue模板**:包含问题描述、重现步骤、报错信息等关键字段 +- **PR模板**:涵盖关联Issue、开发目的、具体变更和测试用例等必要信息 + +## 使用说明 +1. 将`.gitee/ISSUE_TEMPLATE.zh-CN.md`文件复制到目标仓库的`.gitee`目录 +2. 将`.gitee/PULL_REQUEST_TEMPLATE.zh-CN.md`文件同步到目标仓库的`.gitee`目录 +3. 提交Issue或PR时自动生成规范化的模板内容 +4. 根据实际需求修改模板中的占位文本 + +## 贡献指南 +请遵循以下规范提交贡献: +1. 提交Issue时使用ISSUE_TEMPLATE模板 +2. 创建Pull Request时使用PULL_REQUEST_TEMPLATE模板 +3. 确保测试用例包含: + - 新增功能的验证用例 + - 修改功能的回归测试 + - 可能受影响的边缘场景 + +## 许可证 +该项目采用MIT许可证,详情请查看[MIT License](https://opensource.org/licenses/MIT)文档。 \ No newline at end of file -- Gitee