From a2b424946beedfc072886782e0c35fe050cfbbed Mon Sep 17 00:00:00 2001 From: afc163 Date: Thu, 17 Nov 2022 23:58:36 +0800 Subject: [PATCH] docs: update codesandbox url for 5.x and 4.x (#38653) --- .../template-1-bug-report.yml.close | 99 ------------------- .../template-2-feature-request.yml.close | 50 ---------- .github/workflows/issue-labeled.yml | 4 +- docs/react/getting-started.en-US.md | 2 +- docs/react/getting-started.zh-CN.md | 2 +- 5 files changed, 4 insertions(+), 153 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/template-1-bug-report.yml.close delete mode 100644 .github/ISSUE_TEMPLATE/template-2-feature-request.yml.close diff --git a/.github/ISSUE_TEMPLATE/template-1-bug-report.yml.close b/.github/ISSUE_TEMPLATE/template-1-bug-report.yml.close deleted file mode 100644 index 005df9e649..0000000000 --- a/.github/ISSUE_TEMPLATE/template-1-bug-report.yml.close +++ /dev/null @@ -1,99 +0,0 @@ -name: 🇨🇳 报告缺陷（beta） -description: 使用中文 Bug 报告模板提交一个缺陷，当然你也可以用 https://new-issue.ant.design -title: "[Bug] 请替换成合适的标题" -labels: ["🐛+Bug"] -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=%F0%9F%90%9B+Bug&template=template-1-bug-report.yml&title=%5BBug%5D+) 或是 [新功能请求](https://github.com/ant-design/ant-design/issues/new?assignees=&labels=%F0%9F%92%A1%2BFeature%2BRequest&template=template-2-feature-request.yml&title=%5BFeature+Request%5D+) (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。 - - --- - - type: input - id: reproduce - attributes: - label: 重现链接 - description: 请提供一个尽可能精简的 [codesandbox](https://u.ant.design/codesandbox-repro) 或 [GitHub 仓库](https://github.com/ant-design/create-react-app-antd/) 的链接。[什么是最小化重现，为什么这是必需的？](https://github.com/ant-design/antd-issue-helper/blob/master/src/locales/zh/reproModal.md) - validations: - required: true - - type: input - id: version - attributes: - label: antd 版本 - description: 你正在使用的 antd 版本是多少？（注意不是 package.json 里的版本，而是 node_modules/antd 里实际安装的版本） - placeholder: 如 4.16.13 - validations: - required: true - - type: textarea - id: reproduce-steps - attributes: - label: 重现步骤 - description: 请提供一个傻瓜式的操作步骤，方便我们无脑重现问题。 - placeholder: | - 比如： - 1. 点击重现链接里的主按钮 - 2. 等待五秒钟 - 3. 观察按钮的边框 - validations: - required: true - - type: textarea - id: expected - attributes: - label: 期望的结果是什么？ - placeholder: 比如：按钮样式正常，边框一直存在 - validations: - required: true - - type: textarea - id: reality - attributes: - label: 实际的结果是什么？ - placeholder: 比如：按钮样式异常，边框突然丢失 - validations: - required: true - - type: dropdown - id: browsers - attributes: - label: 浏览器 - description: 在哪些浏览器上能重现这个问题？ - multiple: true - options: - - Firefox - - Chrome - - Safari - - Edge - - Internet Explorer - - Others - - type: input - id: browsers-version - attributes: - label: 浏览器版本 - placeholder: 如：版本 95.0.4638.69（正式版本） (x86_64) - - type: dropdown - id: os - attributes: - label: 操作系统 - description: 使用的操作系统是？ - options: - - Windows - - MacOS - - iOS - - Android - - Others - - type: input - id: hidden-tag - attributes: - label: 其他 - description: 不要删除预填内容，否则 issue 会被自动关闭。 - value: - diff --git a/.github/ISSUE_TEMPLATE/template-2-feature-request.yml.close b/.github/ISSUE_TEMPLATE/template-2-feature-request.yml.close deleted file mode 100644 index b9e18c2028..0000000000 --- a/.github/ISSUE_TEMPLATE/template-2-feature-request.yml.close +++ /dev/null @@ -1,50 +0,0 @@ -name: 🇨🇳 功能需求（beta） -description: 使用中文 Bug 报告模板提交一个功能需求，当然你也可以用 https://new-issue.ant.design -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=%F0%9F%90%9B+Bug&template=template-1-bug-report.yml&title=%5BBug%5D+) 或是 [新功能请求](https://github.com/ant-design/ant-design/issues/new?assignees=&labels=%F0%9F%92%A1%2BFeature%2BRequest&template=template-2-feature-request.yml&title=%5BFeature+Request%5D+) (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。 - - --- - - type: textarea - id: needs - attributes: - label: 这个功能解决了什么问题？ - description: | - 请尽可能详尽地说明这个需求的用例和场景。最重要的是：解释清楚是怎样的用户体验需求催生了这个功能上的需求。 - Ant Design 的一个重要设计原则是保持 API 的简洁和直接。通常来说，我们只考虑添加在现有的 API 下无法轻松实现的功能。新功能的用例也应当足够常见。 - validations: - required: true - - type: textarea - id: api - attributes: - label: 你期望的 API 是怎样的？ - description: | - 描述一下你期望这个新功能的 API 是如何使用的，并提供一些代码示例。请用 Markdown 格式化你的代码片段。 - 如果有新的 UI 界面，最好截图展示你期望的界面是什么样的？ - placeholder: | - ```jsx - } {...props} /> - ``` - validations: - required: true - - type: input - id: hidden-tag - attributes: - label: 其他 - description: 不要删除预填内容，否则 issue 会被自动关闭。 - value: diff --git a/.github/workflows/issue-labeled.yml b/.github/workflows/issue-labeled.yml index 6fc3d2f19f..c7ac0aed4d 100644 --- a/.github/workflows/issue-labeled.yml +++ b/.github/workflows/issue-labeled.yml @@ -38,9 +38,9 @@ jobs: token: ${{ secrets.GITHUB_TOKEN }} issue-number: ${{ github.event.issue.number }} body: | - Hello @${{ github.event.issue.user.login }}. Please provide a online reproduction by forking this link https://u.ant.design/codesandbox-repro or a minimal GitHub repository. Issues labeled by `Need Reproduce` will be closed if no activities in 3 days. + Hello @${{ github.event.issue.user.login }}. Please provide a online reproduction by forking codesandbox of [antd@5.x](https://u.ant.design/codesandbox-repro) or [antd@4.x](https://u.ant.design/codesandbox-repro-4x), or provide a minimal GitHub repository. Issues labeled by `Need Reproduce` will be closed if no activities in 3 days. - 你好 @${{ github.event.issue.user.login }}, 我们需要你提供一个在线的重现实例以便于我们帮你排查问题。你可以通过点击 [此处](https://u.ant.design/codesandbox-repro) 创建一个 codesandbox 或者提供一个最小化的 GitHub 仓库。3 天内未跟进此 issue 将会被自动关闭。 + 你好 @${{ github.event.issue.user.login }}, 我们需要你提供一个在线的重现实例以便于我们帮你排查问题。你可以通过点击这里创建一个 [antd@5.x](https://u.ant.design/codesandbox-repro) 或 [antd@4.x](https://u.ant.design/codesandbox-repro-4x) 的 codesandbox，或者提供一个最小化的 GitHub 仓库。3 天内未跟进此 issue 将会被自动关闭。 ![](https://gw.alipayobjects.com/zos/antfincdn/y9kwg7DVCd/reproduce.gif) diff --git a/docs/react/getting-started.en-US.md b/docs/react/getting-started.en-US.md index 92ab7074cb..30a3a94595 100755 --- a/docs/react/getting-started.en-US.md +++ b/docs/react/getting-started.en-US.md @@ -16,7 +16,7 @@ Finally, if you are working in a local development environment, please refer to Here is a simple online codesandbox demo of an Ant Design component to show the usage of Ant Design React.