Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: sync antv shared github config #6599

Merged
merged 3 commits into from
Feb 10, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
84 changes: 84 additions & 0 deletions .github/ISSUE_TEMPLATE/1.bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,84 @@
name: '🐞 Bug Report'
description: Create a report to help us improve, Ask questions in Discussions / 创建一个问题报告以帮助我们改进,提问请到 Discussions
title: '[Bug]: '
labels: ['waiting for maintainer']
body:
- type: markdown
attributes:
value: |
Report errors and exceptions found in the project.

Before submitting a new bug/issue, please check the links below to see if there is a solution or question posted there already:

---

反馈在项目中发现的错误、异常。

在提交新 issue 之前,先通过以下链接检查是否存在相同问题:

> [Issues](../issues) | [Closed Issues](../issues?q=is:issue+is:closed) | [Discussions](../discussions)

- type: textarea
id: description
attributes:
label: Describe the bug / 问题描述
placeholder: |
If there is a code block, please use Markdown syntax, such as:
如包含代码块,请使用 Markdown 语法,如:

```javascript
// Your code here
```
validations:
required: true
- type: input
id: link
attributes:
label: Reproduction link / 复现链接
placeholder: |
CodeSandbox / StackBlitz / ...
description: |
可以使用 CodeSandbox(https://codesandbox.io/s/antv-g2-5-0-template-z2gsmn?file=/src/index.js) 或者 StackBlitz(https://stackblitz.com/) 重现你的问题。
validations:
required: false
- type: textarea
id: steps
attributes:
label: Steps to Reproduce the Bug or Issue / 重现步骤
validations:
required: false
- type: dropdown
id: version
attributes:
label: Version / 版本
options:
- Please select / 请选择
- 🆕 5.x
- 4.x
- 3.x
validations:
required: true
- type: checkboxes
id: OS
attributes:
label: OS / 操作系统
options:
- label: macOS
- label: Windows
- label: Linux
- label: Others / 其他
validations:
required: true
- type: checkboxes
id: Browser
attributes:
label: Browser / 浏览器
options:
- label: Chrome
- label: Edge
- label: Firefox
- label: Safari (Limited support / 有限支持)
- label: IE (Nonsupport / 不支持)
- label: Others / 其他
validations:
required: true
25 changes: 25 additions & 0 deletions .github/ISSUE_TEMPLATE/2.feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
name: '💡 Feature Request'
description: I have a suggestion (and may want to implement it) / 我有一个建议(或者想参与贡献)
title: '[Feat]: '
labels: ['waiting for maintainer']
body:
- type: textarea
id: description
attributes:
label: Describe the feature / 功能描述
description: 'What problem does this feature solve? / 这个功能解决什么问题?'
placeholder: |
I would like to see... because...
我希望能有... 因为...
validations:
required: true

- type: dropdown
attributes:
label: Are you willing to contribute? / 是否愿意参与贡献?
options:
- Please select / 请选择
- ✅ Yes / 是
- ❌ No / 否
validations:
required: true
82 changes: 82 additions & 0 deletions .github/ISSUE_TEMPLATE/3.docs_feedback.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,82 @@
name: '📖 Docs Feedback'
description: 'Help us make our docs better! Share your thoughts and suggestions / 帮助我们改进文档!分享您的想法和建议'
labels: ['waiting for maintainer']
title: '[docs]: '
body:
- type: markdown
attributes:
value: |
### 👋 Hello there! / 您好!

Thank you for helping us improve our documentation! Your feedback is invaluable to us and will help make our docs better for everyone.

感谢您帮助我们改进文档!您的反馈对我们来说非常宝贵,这将帮助我们为所有人提供更好的文档体验。

- type: input
id: page-url
attributes:
label: '📍 Which page are you reading?'
description: "Please share the URL of the page you'd like to give feedback on / 请分享您想要反馈的页面链接"
placeholder: 'https://docs.example.com/'
validations:
required: true

- type: dropdown
id: feedback-type
attributes:
label: "💭 What's on your mind?"
description: 'What kind of feedback would you like to share? / 您想分享什么类型的反馈?'
options:
- 'Could be clearer / 需要更清晰的解释'
- 'Missing information / 信息不完整'
- 'Example needs fixing / 示例需要修复'
- 'Content needs updating / 内容需要更新'
- 'Other suggestions / 其他建议'
validations:
required: true

- type: textarea
id: description
attributes:
label: '🤔 Tell us more'
description: |
Let us know what went wrong when you were using this documentation and what we could do to improve it | 请告知您在使用此文档时遇到的问题以及我们可以改进的地方
placeholder: |
Share your experience:
- What confused you?
- What were you looking for?
- What would have helped you understand better?

分享您的体验:
- 哪里让您感到困惑?
- 您在寻找什么信息?
- 什么样的改进能帮助您更好地理解?
validations:
required: true

- type: textarea
id: suggestion
attributes:
label: '💡 Got any suggestions?'
description: |
What are you trying to accomplish? Providing context helps us come up with a solution that is more useful in the real world | 您希望实现什么目标?提供上下文有助于我们提出更实用的解决方案
placeholder: |
Some ideas you might share:
- Adding more examples
- Including screenshots
- Providing step-by-step guides

您可以建议:
- 添加更多示例
- 包含截图说明
- 提供步骤指南
validations:
required: false

- type: markdown
attributes:
value: |
---
💝 Thanks for taking the time to fill out this form! Your feedback helps make our documentation better for everyone.

感谢您抽出宝贵时间填写这份反馈!您的建议将帮助我们为所有人提供更好的文档。
67 changes: 0 additions & 67 deletions .github/ISSUE_TEMPLATE/bug_report.yml

This file was deleted.

9 changes: 9 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# Ref: https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository#configuring-the-template-chooser
blank_issues_enabled: false
contact_links:
- name: 📝 Question / 问题咨询
url: https://github.com/antvis/github-config/discussions/new?category=q-a
about: Ask the community for help / 向社区寻求帮助
- name: 💬 Join Discussion Group / 加入讨论群
url: https://qr.dingtalk.com/action/joingroup?code=v1,k1,rQHsK/OOTPX8ixM/DaXcL3goIYpnpKr/AFIonmA1SOM=&_dt_no_comment=1&origin=11?
about: Join DingTalk discussion group / 加入钉钉讨论群
2 changes: 1 addition & 1 deletion .github/workflows/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ jobs:

- name: Upload blob report to GitHub Actions Artifacts
if: always()
uses: actions/upload-artifact@v3
uses: actions/upload-artifact@v4
with:
name: snapshots
path: |
Expand Down
37 changes: 37 additions & 0 deletions .github/workflows/ensure-triage-label.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
name: Ensure Triage Label is Present

on:
label:
types:
- deleted
issues:
types:
- opened

permissions: {}

jobs:
label_issues:
runs-on: ubuntu-latest
permissions:
issues: write
steps:
- uses: actions/[email protected]
with:
script: |
const labelToTriage = 'waiting for maintainer';

const { data: labels } = await github.rest.issues.listLabelsOnIssue({
issue_number: context.issue.number,
owner: context.repo.owner,
repo: context.repo.repo,
});

if (labels.length <= 0) {
await github.rest.issues.addLabels({
issue_number: context.issue.number,
owner: context.repo.owner,
repo: context.repo.repo,
labels: [labelToTriage]
})
}
Loading
Loading