mirror of
https://gitee.com/layui/layui.git
synced 2025-04-05 17:38:02 +08:00
chore: 优化 issue 回复文案及其他细节
This commit is contained in:
贤心
GitHub
commit
07259f21db
10
CONTRIBUTING.md → .github/CONTRIBUTING.md
vendored
10
CONTRIBUTING.md → .github/CONTRIBUTING.md
vendored
@ -1,10 +1,10 @@
|
||||
# 🍀 Layui Issue 规范指南
|
||||
# 🍀 Layui Issue 贡献指南
|
||||
|
||||
为了提升沟通效率，请花几分钟时间仔细阅读本文档。遵循这些指南有助于表达您尊重管理和开发这个开源项目的贡献者。作为回报，他们也会以同样的尊重来处理或评估您的问题和功能请求。
|
||||
|
||||
### 创建 Issue 之前
|
||||
|
||||
Layui 的 issue 只受理 「Bug 报告」和「新功能请求」。如果是关于如何使用、功能疑惑或其他业务相关的问题建议在 Discussions 寻找社区帮助。若 issue 不符合规定或违背社区行为准则，它将会被立即关闭。
|
||||
Layui 的 issue 只受理 「Bug 报告」和「功能请求」。如果是关于如何使用、功能疑惑或其他业务相关的问题建议在 Discussions 寻找社区帮助。若 issue 不符合规定或违背社区行为准则，它将会被立即关闭。
|
||||
|
||||
**在正式创建 Issue 之前，您应当确保已完成以下前置工作**：
|
||||
|
||||
@ -27,16 +27,16 @@ Layui 的 issue 只受理 「Bug 报告」和「新功能请求」。如果是
|
||||
|
||||
**最重要的是，请明白一件事：开源项目的用户和维护者之间并不是甲方和乙方的关系，issue 也不是客服。在开 issue 的时候，请抱着「一起合作来解决这个问题」的心态，避免期待社区单方面地为你服务。**
|
||||
|
||||
> 以上概述借鉴了 Ant Design 社区的成熟经验，并做了适用于 Layui 社区的相关修改。
|
||||
> 以上借鉴了 Ant Design 社区的成熟经验，并做了适用于 Layui 社区的相关修改。
|
||||
|
||||
### 正式创建 issue
|
||||
|
||||
当您已对上述事项充分阅读并理解，在正式创建过程中，您应当遵循 Issue 提供表达规范仔细填写，尽可能将您所遇到的 Bug 或 Feature Request 描述详细。
|
||||
当您已对上述事项充分阅读并理解，在正式创建过程中，您应当遵循 Issue 提供表单规范仔细填写，尽可能将您所遇到的 Bug 或 Feature Request 描述详细。
|
||||
|
||||
### 创建 issue 之后
|
||||
|
||||
- 在 issue 交流过程中，若议题已经得到解决，请主动关闭 issue。
|
||||
- 大家应本着相互尊重、理解和友善的态度，共同维护 Layui 来之不易的良好的社区氛围，谢谢 💖。
|
||||
- 大家本着相互尊重、理解和友善的态度，共同维护 Layui 来之不易的良好的社区氛围，谢谢 💖。
|
||||
|
||||
|
||||
### 其他参考资料
|
||||
@ -10,7 +10,7 @@ body:
|
||||
required: true
|
||||
- label: 我确认已在 [Issues](https://github.com/layui/layui/issues?q=is%3Aissue ) 中搜索过类似的问题，但没有找到相关解决方案。
|
||||
required: true
|
||||
- label: 我已仔细阅读： 🍀[ Layui Issue 规范指南](https://github.com/layui/layui/blob/main/CONTRIBUTING.md)
|
||||
- label: 我已仔细阅读： 🍀[ Layui Issue 贡献指南](https://github.com/layui/layui/blob/main/.github/CONTRIBUTING.md)
|
||||
required: true
|
||||
- type: dropdown
|
||||
id: type
|
||||
30
.github/workflows/issue-labeled.yml
vendored
30
.github/workflows/issue-labeled.yml
vendored
@ -14,6 +14,12 @@ jobs:
|
||||
pull-requests: write
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: content template
|
||||
id: template
|
||||
run: |
|
||||
DIR_NAME="详见：🍀 [Layui Issue 贡献指南](https://github.com/layui/layui/blob/main/.github/CONTRIBUTING.md)"
|
||||
echo "CONTRIBUTING=$DIR_NAME" >> $GITHUB_OUTPUT
|
||||
|
||||
- name: help wanted
|
||||
if: github.event.label.name == 'help wanted'
|
||||
uses: actions-cool/issues-helper@v3
|
||||
@ -21,8 +27,9 @@ jobs:
|
||||
actions: 'create-comment'
|
||||
token: ${{ secrets.GITHUB_TOKEN }}
|
||||
body: |
|
||||
@${{ github.event.issue.user.login }} 很棒 👋
|
||||
我们有意愿采纳这项议题，欢迎您创建 [Pull Request](https://github.com/layui/layui/pulls) 来协助实现，若变更内容涉及到 API 新增和改动，除了提交核心代码外，还需包含：[文档](https://github.com/layui/layui/tree/main/docs)、测试用例等相关文件，以便我们更好地进行 Review。期待您的贡献!
|
||||
@${{ github.event.issue.user.login }} 你好 👋。
|
||||
我们赞成为该议题寻求社区帮助，欢迎创建 [Pull Request](https://github.com/layui/layui/pulls) 来协助实现，若变更内容涉及到 API 新增和改动，除了提交核心代码外，还需包含：文档、测试用例等相关文件，以便我们更好地进行 Review。期待您的贡献!
|
||||
> ${{ steps.template.outputs.CONTRIBUTING }}
|
||||
|
||||
- name: invalid
|
||||
if: github.event.label.name == 'invalid'
|
||||
@ -31,9 +38,9 @@ jobs:
|
||||
actions: 'create-comment,close-issue'
|
||||
token: ${{ secrets.GITHUB_TOKEN }}
|
||||
body: |
|
||||
@${{ github.event.issue.user.login }} 你好，为了提升沟通效率，我们对 Issue 制定了规范要求，你的 Issue 因不符合规范而被自动关闭。
|
||||
建议您在下次创建 Issue 时，遵循表单模板规范填写。谢谢。
|
||||
> 相关延伸：👉 [**提问的智慧**](https://github.com/tvvocold/How-To-Ask-Questions-The-Smart-Way)
|
||||
@${{ github.event.issue.user.login }} 你好，为了提升沟通效率，我们对 Issue 制定了严格的要求，你的 Issue 因不符合规定而被自动关闭。
|
||||
建议您在下次创建 Issue 时，遵循相应规范和社区行为准则。谢谢。
|
||||
> ${{ steps.template.outputs.CONTRIBUTING }}
|
||||
|
||||
- name: need reproduce
|
||||
if: github.event.label.name == 'need reproduce'
|
||||
@ -46,7 +53,8 @@ jobs:
|
||||
- 产生问题的详细步骤
|
||||
- 与问题相关的完整代码
|
||||
- 在线 Demo (推荐通过 [stackblitz](https://stackblitz.com/) 或 [codepen](https://codepen.io/) 创建)
|
||||
> 相关延伸：👉 [为什么要提供最小化重现？](https://antfu.me/posts/why-reproductions-are-required-zh)
|
||||
> ${{ steps.template.outputs.CONTRIBUTING }}
|
||||
> 延伸：👉 [为什么要提供最小化重现？](https://antfu.me/posts/why-reproductions-are-required-zh)
|
||||
|
||||
- name: discussion
|
||||
if: github.event.label.name == 'discussion'
|
||||
@ -55,10 +63,11 @@ jobs:
|
||||
actions: 'create-comment,close-issue'
|
||||
token: ${{ secrets.GITHUB_TOKEN }}
|
||||
body: |
|
||||
@${{ github.event.issue.user.login }} 你好，Issue 一般只接受「Bug 报告」和「新功能请求」，而您的议题涉及到基础用法和功能疑惑等业务相关的讨论，这并不适合作为 Issue 讨论。建议您通过以下方式寻求解决方案：
|
||||
@${{ github.event.issue.user.login }} 你好，Issue 一般只接受「Bug 报告」和「功能请求」，而您的议题涉及到如何使用、功能疑惑或其他业务相关的问题，这并不适合作为 Issue 讨论。建议您通过以下方式寻求解决方案：
|
||||
- 仔细查阅 Layui 官方文档：https://layui.dev
|
||||
- 搜索相关技术资料或咨询人工智能大模型
|
||||
- 通过其他技术社区搜索相关资料、或充分利用当前主流的人工智能大模型
|
||||
- [Discussions](https://github.com/layui/layui/discussions)
|
||||
> ${{ steps.template.outputs.CONTRIBUTING }}
|
||||
|
||||
- name: unrelated
|
||||
if: github.event.label.name == 'unrelated'
|
||||
@ -67,6 +76,7 @@ jobs:
|
||||
actions: 'create-comment,close-issue'
|
||||
token: ${{ secrets.GITHUB_TOKEN }}
|
||||
body: |
|
||||
@${{ github.event.issue.user.login }} 经过确认，您提出的问题与 Layui 不存在相关联。建议通过以下方式寻求解决方案：
|
||||
- 搜索相关技术资料或咨询人工智能大模型
|
||||
@${{ github.event.issue.user.login }} 您提出的问题与 Layui 可能不存在相关联。建议通过以下方式寻求解决方案：
|
||||
- 通过其他技术社区搜索相关资料、或充分利用当前主流的人工智能大模型
|
||||
- [Discussions](https://github.com/layui/layui/discussions)
|
||||
> ${{ steps.template.outputs.CONTRIBUTING }}
|
||||
|
||||
Loading…
Reference in New Issue
Block a user