mirror of
https://github.com/continew-org/continew-starter.git
synced 2025-09-09 04:59:21 +08:00
docs: 新增 Issues 和 PR 模板
This commit is contained in:
57
.github/ISSUE_TEMPLATE/bug_report.yml
vendored
Normal file
57
.github/ISSUE_TEMPLATE/bug_report.yml
vendored
Normal file
@@ -0,0 +1,57 @@
|
|||||||
|
name: "\U0001F41E Bug 报告"
|
||||||
|
description: Create a report to help us improve
|
||||||
|
labels: ['bug: pending triage']
|
||||||
|
body:
|
||||||
|
- type: markdown
|
||||||
|
attributes:
|
||||||
|
value: |
|
||||||
|
感谢您使用 ContiNew Starter!请您花些时间填写这份 Bug 报告。
|
||||||
|
- type: textarea
|
||||||
|
id: bug-description
|
||||||
|
attributes:
|
||||||
|
label: Bug 描述
|
||||||
|
description: 清楚而简洁地描述您遇到的 Bug。另外,非常欢迎您对此 Bug 提交 PR。
|
||||||
|
placeholder: 例如:在使用 xxx 功能时出现异常
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: textarea
|
||||||
|
id: reproduction
|
||||||
|
attributes:
|
||||||
|
label: 复现步骤
|
||||||
|
description: 条理清晰的步骤或演示视频可以帮助快速定位问题。
|
||||||
|
placeholder: 例如:1、xxx; 2、xxx;
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: textarea
|
||||||
|
id: expected
|
||||||
|
attributes:
|
||||||
|
label: 预期结果
|
||||||
|
description: 清楚而简洁地描述您期望的结果。
|
||||||
|
placeholder: 预期结果
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: textarea
|
||||||
|
id: environment-info
|
||||||
|
attributes:
|
||||||
|
label: 环境信息
|
||||||
|
description: 描述清楚您所使用的相关环境,例如:JDK 版本:1.8.0_202;Starter 版本:v1.0.0;其他可能与该 issue 相关的依赖版本。
|
||||||
|
placeholder: JDK 版本, Starter 版本等
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: textarea
|
||||||
|
id: additional-context
|
||||||
|
attributes:
|
||||||
|
label: 额外补充
|
||||||
|
description: 添加您的完整报错信息或屏幕截图,以及一切能帮助定位问题的信息。
|
||||||
|
- type: checkboxes
|
||||||
|
id: checkboxes
|
||||||
|
attributes:
|
||||||
|
label: 确认
|
||||||
|
description: 在提交 issue 之前,请确保执行过以下操作。
|
||||||
|
options:
|
||||||
|
- label: 阅读文档
|
||||||
|
required: true
|
||||||
|
- label: 根据报错信息百度或 Google 一下
|
||||||
|
required: true
|
||||||
|
- label: 搜索是否有其他人提交过类似的 issue,如果对应 issue 尚未解决,您可以先订阅关注该 issue(为了方便后来者查找问题解决方法,请尽量避免创建重复的 issue)
|
||||||
|
required: true
|
42
.github/ISSUE_TEMPLATE/feature_request.yml
vendored
Normal file
42
.github/ISSUE_TEMPLATE/feature_request.yml
vendored
Normal file
@@ -0,0 +1,42 @@
|
|||||||
|
name: "\U0001F680 新 Feature 建议"
|
||||||
|
description: Suggest an idea for this project
|
||||||
|
body:
|
||||||
|
- type: markdown
|
||||||
|
attributes:
|
||||||
|
value: |
|
||||||
|
感谢您使用 ContiNew Starter!请您花些时间填写这份 Feature 调查。
|
||||||
|
- type: textarea
|
||||||
|
id: feature-description
|
||||||
|
attributes:
|
||||||
|
label: Feature 描述
|
||||||
|
description: 清楚而简洁地描述您的 Feature。另外,非常欢迎您对此 Feature 提交 PR。
|
||||||
|
placeholder: 例如:我希望增加 xxx 功能;现有的 xxx 功能不好用...
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: textarea
|
||||||
|
id: suggested-solution
|
||||||
|
attributes:
|
||||||
|
label: 描述一下您想要的解决方案
|
||||||
|
description: 清楚而简洁地描述您想要的解决方案。
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: textarea
|
||||||
|
id: alternative
|
||||||
|
attributes:
|
||||||
|
label: 描述一下您考虑过的替代方案
|
||||||
|
description: 清楚而简洁地描述您考虑过的任何替代解决方案或功能。
|
||||||
|
- type: textarea
|
||||||
|
id: additional-context
|
||||||
|
attributes:
|
||||||
|
label: 额外补充
|
||||||
|
description: 添加您在其他框架或场景遇见的效果截图或链接,以及一切能帮助理解 Feature 的信息。
|
||||||
|
- type: checkboxes
|
||||||
|
id: checkboxes
|
||||||
|
attributes:
|
||||||
|
label: 确认
|
||||||
|
description: 在提交 issue 之前,请确保执行过以下操作。
|
||||||
|
options:
|
||||||
|
- label: 阅读文档
|
||||||
|
required: true
|
||||||
|
- label: 搜索是否有其他人提交过类似的 issue,如果对应 issue 尚未解决,您可以先订阅关注该 issue(为了方便后来者查找问题解决方法,请尽量避免创建重复的 issue)
|
||||||
|
required: true
|
53
.github/PULL_REQUEST_TEMPLATE.md
vendored
Normal file
53
.github/PULL_REQUEST_TEMPLATE.md
vendored
Normal file
@@ -0,0 +1,53 @@
|
|||||||
|
<!--
|
||||||
|
非常感谢您的 PR!在提交之前,请务必确保您 PR 的代码经过了完整测试,并且通过了代码规范检查。
|
||||||
|
-->
|
||||||
|
|
||||||
|
<!-- 在 [] 中输入 x 来勾选) -->
|
||||||
|
|
||||||
|
## PR 类型
|
||||||
|
|
||||||
|
<!-- 您的 PR 引入了哪种类型的变更? -->
|
||||||
|
<!-- 只支持选择一种类型,如果有多种类型,可以在更新日志中增加 “类型” 列。 -->
|
||||||
|
|
||||||
|
- [ ] 新 feature
|
||||||
|
- [ ] Bug 修复
|
||||||
|
- [ ] 功能增强
|
||||||
|
- [ ] 文档变更
|
||||||
|
- [ ] 代码样式变更
|
||||||
|
- [ ] 重构
|
||||||
|
- [ ] 性能改进
|
||||||
|
- [ ] 单元测试
|
||||||
|
- [ ] CI/CD
|
||||||
|
- [ ] 其他
|
||||||
|
|
||||||
|
## PR 目的
|
||||||
|
|
||||||
|
<!-- 描述一下您的 PR 解决了什么问题。如果可以,请链接到相关 issues。 -->
|
||||||
|
|
||||||
|
## 解决方案
|
||||||
|
|
||||||
|
<!-- 详细描述您是如何解决的问题 -->
|
||||||
|
|
||||||
|
## PR 测试
|
||||||
|
|
||||||
|
<!-- 如果可以,请为您的 PR 添加或更新单元测试。 -->
|
||||||
|
<!-- 请描述一下您是如何测试 PR 的。例如:创建/更新单元测试或添加相关的截图。 -->
|
||||||
|
|
||||||
|
## Changelog
|
||||||
|
|
||||||
|
| 模块 | Changelog | Related issues |
|
||||||
|
|-----|-----------| -------------- |
|
||||||
|
| | | |
|
||||||
|
|
||||||
|
<!-- 如果有多种类型的变更,可以在变更日志表中增加 “类型” 列,该列的值与上方 “PR 类型” 相同。 -->
|
||||||
|
<!-- Related issues 格式为 Closes #<issue号>,或者 Fixes #<issue号>,或者 Resolves #<issue号>。 -->
|
||||||
|
|
||||||
|
## 其他信息
|
||||||
|
|
||||||
|
<!-- 请描述一下还有哪些注意事项。例如:如果引入了一个不向下兼容的变更,请描述其影响。 -->
|
||||||
|
|
||||||
|
## 提交前确认
|
||||||
|
|
||||||
|
- [ ] PR 代码经过了完整测试,并且通过了代码规范检查
|
||||||
|
- [ ] 已经完整填写 Changelog,并链接到了相关 issues
|
||||||
|
- [ ] PR 代码将要提交到 dev 分支
|
@@ -23,7 +23,7 @@
|
|||||||
|
|
||||||
## 简介
|
## 简介
|
||||||
|
|
||||||
ContiNew Starter
|
ContiNew Starter(Continue New Starter)是一种特殊类型的 Spring Boot Starter,其作用与常规的 Starter 类似,它可以帮助开发人员快速集成常用的第三方库或工具到 Spring 应用程序中。ContiNew Starter 包含了一系列经过优化和配置的依赖包(如 MyBatis-Plus、SaToken),可轻松集成到应用中,从而避免开发人员手动引入依赖的麻烦,为 Spring Boot 项目的灵活快速构建提供支持。
|
||||||
|
|
||||||
## 项目源码
|
## 项目源码
|
||||||
|
|
||||||
|
7
pom.xml
7
pom.xml
@@ -25,7 +25,12 @@
|
|||||||
<packaging>pom</packaging>
|
<packaging>pom</packaging>
|
||||||
|
|
||||||
<name>${project.artifactId}</name>
|
<name>${project.artifactId}</name>
|
||||||
<description>ContiNew Starter</description>
|
<description>
|
||||||
|
ContiNew Starter 是一种特殊类型的 Spring Boot Starter,
|
||||||
|
其作用与常规的 Starter 类似,它可以帮助开发人员快速集成常用的第三方库或工具到 Spring 应用程序中。
|
||||||
|
ContiNew Starter 包含了一系列经过优化和配置的依赖包,可轻松集成到应用中,
|
||||||
|
从而避免开发人员手动引入依赖的麻烦,为 Spring Boot 项目的灵活快速构建提供支持。
|
||||||
|
</description>
|
||||||
<url>https://github.com/Charles7c/continew-starter</url>
|
<url>https://github.com/Charles7c/continew-starter</url>
|
||||||
<licenses>
|
<licenses>
|
||||||
<license>
|
<license>
|
||||||
|
Reference in New Issue
Block a user