From 79c741b68e3991de2903a86a6423049c16cf93ae Mon Sep 17 00:00:00 2001 From: Charles7c <charles7c@126.com> Date: Sat, 14 Jan 2023 11:22:25 +0800 Subject: [PATCH] =?UTF-8?q?=E5=AE=8C=E5=96=84=EF=BC=9A=E5=AE=8C=E5=96=84?= =?UTF-8?q?=20README=20=E6=96=87=E6=A1=A3=EF=BC=8C=E6=96=B0=E5=A2=9E?= =?UTF-8?q?=E9=83=A8=E5=88=86=E5=8A=9F=E8=83=BD=E6=88=AA=E5=9B=BE=E9=83=A8?= =?UTF-8?q?=E5=88=86=E5=86=85=E5=AE=B9=EF=BC=8C=E5=B9=B6=E6=96=B0=E5=A2=9E?= =?UTF-8?q?=20GitHub=20issues=20=E5=92=8C=20PR=20=E6=A8=A1=E6=9D=BF?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .github/ISSUE_TEMPLATE/bug_report.yml | 57 ++++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.yml | 42 ++++++++++++++++ .github/PULL_REQUEST_TEMPLATE.md | 51 +++++++++++++++++++ README.md | 25 ++++++++++ 4 files changed, 175 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml create mode 100644 .github/PULL_REQUEST_TEMPLATE.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 00000000..d7e28170 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -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 Admin！请您花些时间填写这份 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；框架版本：v1.0.0；其他可能与该 issue 相关的依赖版本。 + placeholder: JDK 版本, 框架版本等 + validations: + required: true + - type: textarea + id: additional-context + attributes: + label: 额外补充 + description: 添加您的完整报错信息或屏幕截图，以及一切能帮助定位问题的信息。 + - type: checkboxes + id: checkboxes + attributes: + label: 确认 + description: 在提交 issue 之前，请确保执行过以下操作。 + options: + - label: 阅读[文档](https://github.com/Charles7c/continew-admin#readme) + required: true + - label: 根据报错信息百度或 Google 一下 + required: true + - label: 搜索是否有其他人提交过类似的 issue，如果对应 issue 尚未解决，您可以先订阅关注该 issue（为了方便后来者查找问题解决方法，请尽量避免创建重复的 issue） + required: true \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 00000000..0fdd67b0 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,42 @@ +name: "\U0001F680 新 Feature 建议" +description: Suggest an idea for this project +body: + - type: markdown + attributes: + value: | + 感谢您使用 ContiNew Admin！请您花些时间填写这份 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: 阅读[文档](https://github.com/Charles7c/continew-admin#readme) + required: true + - label: 搜索是否有其他人提交过类似的 issue，如果对应 issue 尚未解决，您可以先订阅关注该 issue（为了方便后来者查找问题解决方法，请尽量避免创建重复的 issue） + required: true \ No newline at end of file diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 00000000..4aa7bc27 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,51 @@ +<!-- + 非常感谢您的 PR！在提交之前，请务必确保您 PR 的代码经过了完整测试，并且通过了代码规范检查。 +--> + +<!-- 在 [] 中输入 x 来勾选) --> + +## PR 类型 + +<!-- 您的 PR 引入了哪种类型的变更？ --> +<!-- 只支持选择一种类型，如果有多种类型，可以在更新日志中增加 “类型” 列。 --> + +- [ ] 新 feature +- [ ] Bug 修复 +- [ ] 功能增强 +- [ ] 文档变更 +- [ ] 代码样式变更 +- [ ] 重构 +- [ ] 单元测试 +- [ ] CI/CD +- [ ] 其他 + +## PR 目的 + +<!-- 描述一下您的 PR 解决了什么问题。如果可以，请链接到相关 issues。 --> + +## 解决方案 + +<!-- 详细描述您是如何解决的问题 --> + +## PR 测试 + +<!-- 如果可以，请为您的 PR 添加或更新单元测试。 --> +<!-- 请描述一下您是如何测试 PR 的。例如：创建/更新单元测试或添加相关的截图。 --> + +## Changelog + +| 模块 | Changelog | Related issues | +|-----|-----------| -------------- | +| | | | + +<!-- 如果有多种类型的变更，可以在变更日志中增加 “类型” 列，该列的值与上方 “PR 类型” 相同。 --> + +## 其他信息 + +<!-- 请描述一下还有哪些注意事项。例如：如果引入了一个不向下兼容的变更，请描述其影响。 --> + +## 提交前确认 + +- [ ] PR 代码经过了完整测试，并且通过了代码规范检查 +- [ ] 已经完整填写 Changelog，并链接到了相关 issues +- [ ] PR 代码将要提交到 dev 分支 \ No newline at end of file diff --git a/README.md b/README.md index 14d15996..292de20e 100644 --- a/README.md +++ b/README.md @@ -90,6 +90,31 @@ yarn dev | [Hutool](https://www.hutool.cn/) | 5.8.11 | 小而全的 Java 工具类库，通过静态方法封装，降低相关 API 的学习成本，提高工作效率，使 Java 拥有函数式语言般的优雅，让 Java 语言也可以“甜甜的”。 | | [Lombok](https://projectlombok.org/) | 1.18.24 | 在 Java 开发过程中用注解的方式，简化了 JavaBean 的编写，避免了冗余和样板式代码，让编写的类更加简洁。 | +## 部分功能截图 + +<table border="1" cellpadding="1" cellspacing="1" style="width:500px"> + <tbody> + <tr> + <td><img src="https://s1.ax1x.com/2023/01/14/pSMl7cV.png" alt="登录页面" width="1920" /></td> + <td><img src="https://s1.ax1x.com/2023/01/14/pSMlHXT.png" alt="仪表盘" width="1920" /></td> + </tr> + <tr> + <td> + <p><img src="https://s1.ax1x.com/2023/01/14/pSMl4ts.png" alt="个人中心" width="1920" /></p> + </td> + <td><img src="https://s1.ax1x.com/2023/01/14/pSMlopq.png" alt="安全设置" width="1920" /></td> + </tr> + <tr> + <td><img src="https://s1.ax1x.com/2023/01/14/pSMlT10.png" alt="安全设置-修改密码" width="1920" /></td> + <td><img src="https://s1.ax1x.com/2023/01/14/pSMl5hn.png" alt="安全设置-修改邮箱" width="1920" /></td> + </tr> + <tr> + <td><img src="https://s1.ax1x.com/2023/01/14/pSM33M6.png" alt="修改邮箱-发送验证码" width="1920" /></td> + <td><img src="https://s1.ax1x.com/2023/01/14/pSM3lxx.png" alt="修改邮箱-邮箱验证码" width="1920" /></td> + </tr> + </tbody> +</table> + ## 项目结构 ### 后端