Browse Source

chore: add ISSUE_TEMPLATE

pull/32733/head
afc163 3 years ago
parent
commit
75fde3806b
  1. 10
      .github/ISSUE_TEMPLATE/template-1-bug-report.yml
  2. 45
      .github/ISSUE_TEMPLATE/template-2-feature-request.yml

10
.github/ISSUE_TEMPLATE/template-1-bug-report.yml

@ -1,16 +1,18 @@
name: 🇨🇳 报告缺陷(beta)
description: 使用中文模板报告一个缺陷
description: 使用中文 Bug 报告模板提交一个缺陷
title: "[Bug] "
labels: ["bug"]
labels: ["🐛+Bug"]
body:
- type: markdown
attributes:
value: |
Ant Design 的 issue 列表只接受 Bug 报告或是新功能请求 (Feature Request)。这意味着我们不接受用法问题(How to 类问题)。如果你开的 issue 不符合规定,它将会被立刻关闭。[为什么要这么严格?](https://github.com/ant-design/antd-issue-helper/blob/master/src/locales/zh/introModal.md)
除了此表单,你也可以使用 [Ant Design Issue Helper](https://new-issue.ant.design/) 来新建 issue。
Ant Design 的 issue 列表只接受 [Bug 报告](https://github.com/ant-design/ant-design/issues/new?assignees=&labels=bug&template=template-1-bug-report.yml&title=%5BBug%5D+) 或是 [新功能请求](https://github.com/ant-design/ant-design/issues/new?assignees=&labels=💡+Feature+Request&template=template-1-feature-request.yml&title=[Feature Request]+)(Feature Request)。这意味着我们不接受用法问题(How to 类问题)。如果你开的 issue 不符合规定,它将会被立刻关闭。[为什么要这么严格?](https://github.com/ant-design/antd-issue-helper/blob/master/src/locales/zh/introModal.md)
对于使用中遇到的问题,请使用以下资源:
- 将问题发到 [GitHub 讨论区](https://github.com/ant-design/ant-design/discussions) 而不是 Issue。
- 用法类问题发到 [GitHub 讨论区](https://github.com/ant-design/ant-design/discussions) 而不是 Issue。
- 仔细阅读 [使用文档](https://ant.design/docs/react/introduce-cn) 和 [组件文档](https://ant.design/components/overview-cn/)。
- 提问前确保你在 [常见问题](https://ant.design/docs/react/faq-cn) 和 [更新日志](https://ant.design/changelog-cn) 中搜索过。
- 在 [StackOverflow](https://stackoverflow.com/questions/tagged/antd) (英文) 或是 [SegmentFault](https://segmentfault.com/t/antd)(中文)搜索和提问。

45
.github/ISSUE_TEMPLATE/template-2-feature-request.yml

@ -0,0 +1,45 @@
name: 🇨🇳 功能需求(beta)
description: 使用中文 Bug 报告模板提交一个功能需求
title: "[Feature Request] "
labels: ["💡+Feature+Request"]
body:
- type: markdown
attributes:
value: |
除了此表单,你也可以使用 [Ant Design Issue Helper](https://new-issue.ant.design/) 来新建 issue。
Ant Design 的 issue 列表只接受 [Bug 报告](https://github.com/ant-design/ant-design/issues/new?assignees=&labels=🐛+Bug&template=template-1-bug-report.yml&title=%5BBug%5D+) 或是 [新功能请求](https://github.com/ant-design/ant-design/issues/new?assignees=&labels=💡+Feature+Request&template=template-1-feature-request.yml&title=[Feature Request]+)(Feature Request)。这意味着我们不接受用法问题(How to 类问题)。如果你开的 issue 不符合规定,它将会被立刻关闭。[为什么要这么严格?](https://github.com/ant-design/antd-issue-helper/blob/master/src/locales/zh/introModal.md)
对于使用中遇到的问题,请使用以下资源:
- 将用法类问题发到 [GitHub 讨论区](https://github.com/ant-design/ant-design/discussions) 而不是 Issue。
- 仔细阅读 [使用文档](https://ant.design/docs/react/introduce-cn) 和 [组件文档](https://ant.design/components/overview-cn/)。
- 提问前确保你在 [常见问题](https://ant.design/docs/react/faq-cn) 和 [更新日志](https://ant.design/changelog-cn) 中搜索过。
- 在 [StackOverflow](https://stackoverflow.com/questions/tagged/antd) (英文) 或是 [SegmentFault](https://segmentfault.com/t/antd)(中文)搜索和提问。
最后,在开 issue 前,可以先搜索一下以往的旧 issue - 你遇到的问题可能已经有人提了,也可能已经在最新版本中被修正。注意:如果你发现一个已经关闭的旧 issue 在最新版本中仍然存在,请不要在旧 issue 下面留言,而应该用下面的表单开一个新的 issue。
<!-- generated by ant-design-issue-helper. DO NOT REMOVE -->
- type: input
id: needs
attributes:
label: 这个功能解决了什么问题?
description: |
请尽可能详尽地说明这个需求的用例和场景。最重要的是:解释清楚是怎样的用户体验需求催生了这个功能上的需求。
Ant Design 的一个重要设计原则是保持 API 的简洁和直接。通常来说,我们只考虑添加在现有的 API 下无法轻松实现的功能。新功能的用例也应当足够常见。
validations:
required: true
- type: input
id: api
attributes:
label: 你期望的 API 是怎样的?
description: |
描述一下你期望这个新功能的 API 是如何使用的,并提供一些代码示例。请用 Markdown 格式化你的代码片段。
如果有新的 UI 界面,最好截图展示你期望的界面是什么样的?
placeholder: |
```jsx
<Drawer extra={<Button />} {...props} />
```
validations:
required: true
Loading…
Cancel
Save