From c152e4d53041a0a51110c846609d8c8b4feb54e4 Mon Sep 17 00:00:00 2001 From: YiXuan Ding <1328032567@qq.com> Date: Mon, 16 Dec 2024 00:11:18 +0800 Subject: [PATCH] : modify and merge repeated section. --- .github/pull_request_template.md | 102 ++++++++++++++++--------------- 1 file changed, 54 insertions(+), 48 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 4b3ce17c..42648acd 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,76 +1,82 @@ --- -name: Pull Request -about: 提交PR以改进或修复`chsrc`工具的功能 -title: "[PR] " -labels: '' -assignees: '' +name: Pull Request +about: 提交PR以改进或修复`chsrc`工具的功能 +title: "[PR] " +labels: '' +assignees: '' --- ### 描述 -简要描述此PR的目的或所修复的问题。例如: - -- 本PR修复了`chsrc list`命令中列出镜像源时的排序问题。 -- 本PR增加了对IPv6测速的支持,允许在使用`chsrc measure`时指定`-ipv6`选项。 -- 本PR优化了`set`命令的镜像源选择逻辑,使其自动选择最优源。 +- **问题的背景** + 简要说明此PR修复的具体问题或改进的功能背景。 + + 例如: + - 当前`chsrc list`命令无法正确排序镜像源列表。 + - `chsrc measure`命令不支持IPv6测速。 + - `chsrc set`命令的源选择逻辑不够智能,无法自动选择最快源。 + +- **相关Issue** + 列出与此PR相关的Issue或任务。 + + 例如: + - Closes #123 (修复了`list`命令的问题) + - Depends on #789 (等待依赖PR的合并) + +- **这个PR做了什么** + 简要描述本PR的改动内容。 + + 例如: + - 修复了`list`命令的排序问题。 + - 增加了对IPv6的测速支持。 + - 优化了`set`命令的源选择逻辑。 --- -### 变更内容 - -列出此PR中的主要更改项: - -- [ ] 修复了`list`命令在某些情况下无法正确显示镜像源列表的问题。 -- [ ] 增加了对IPv6的支持,允许`measure`命令使用`-ipv6`选项进行测速。 -- [ ] 改进了`set `命令的镜像源选择逻辑,自动挑选最快源。 -- [ ] 更新了帮助文档,添加了`-no-color`选项的说明。 +### 方案 ---- - -### 相关问题 +简要描述针对该问题或功能改进的解决方案。 -列出与本PR相关的Issue或任务,使用链接格式进行引用: +例如: -- Closes #123 (修复了`list`命令的问题) -- Depends on #789 (等待依赖PR的合并) +- 对`list`命令进行了排序优化,确保镜像源按照正确的顺序展示。 +- 在`measure`命令中加入了`-ipv6`选项,支持IPv6测速。 +- 对`set`命令进行了改进,加入了自动选择最快镜像源的逻辑。 --- -### 测试说明 - -描述如何验证该PR: +### 实现 -- 运行`chsrc list`命令,验证镜像源是否按正确的顺序列出。 -- 使用`chsrc measure -ipv6`进行IPv6测速,确保能正确测速。 -- 运行`chsrc set `命令,验证是否能自动选择最快的源并成功更换。 -- 使用`chsrc set https://custom-mirror-url`验证是否能通过自定义URL成功更换源。 -- 测试`-no-color`选项,验证输出是否正确显示无色彩的命令行。 +详细描述本PR的具体实现,包括代码改动的关键点和实现方式。 ---- - -### 备注 - -如果有其他需要注意的事项,请在此部分添加: +例如: -- `-ipv6`选项需要网络环境支持IPv6地址,测试时请确保IPv6可用。 -- 在使用`-dry`选项进行模拟时,命令只会打印过程,而不会实际执行更换源操作。 +- 在`list`命令中使用新的排序算法。 +- 在`measure`命令中添加了IPv6支持,具体通过解析`-ipv6`选项来启用。 +- 修改了`set`命令的源选择逻辑,通过测速算法选择最快源。 --- -### 风险与注意事项 +### 注意 -列出本PR可能带来的风险和需要特别关注的地方: +列出需要特别注意的事项。 -- **向后兼容性**:此更改向后兼容,所有命令和选项均未改变原有行为。 -- **性能影响**:增加了IPv6测速支持,理论上测速速度可能略有变化,取决于网络环境。 -- **网络依赖性**:测速命令(`measure`)依赖于网络连接的质量,可能会受到网络状况的影响。 +例如: + +- `-ipv6`选项需要网络环境支持IPv6地址,测试时请确保IPv6可用。 +- 在使用`-dry`选项进行模拟时,命令只会打印过程,而不会实际执行更换源操作。 +- 此PR向后兼容,原有命令和选项不受影响。 --- -### 总结 +### 测试 + +描述如何验证本PR,列出具体的测试步骤。 -简要总结PR的内容和预期效果: +例如: -- 本PR增加了对IPv6测速的支持,并改进了`set`命令的源选择逻辑。用户将能够更方便地切换到最快的源,同时可以在支持IPv6的网络环境下进行测速。 -- 下一步计划:监控测速结果的准确性,并根据用户反馈进一步优化源选择算法。 +- 运行`chsrc list`命令,验证镜像源是否按正确的顺序列出。 +- 使用`chsrc measure -ipv6`进行IPv6测速,确保能够正常测速。 +- 运行`chsrc set `命令,验证是否能够自动选择最快的源并成功更换。 +---