chore: add issue hunt program docs and templates (#4517)

* chore: add issue hunt program docs and templates * docs: update hunt issue docs * chore: add workflow to auto replay when add labels * docs: update issue hunt description
2024-12-05 05:09:07 +08:00 · 2023-05-22 17:17:35 +08:00 · 2023-05-22 17:17:35 +08:00 · 444ffdef3f
commit 444ffdef3f
parent ca64e595fe
5 changed files with 412 additions and 0 deletions
--- a/.github/ISSUE_TEMPLATE/issue_hunt.yml
+++ b/.github/ISSUE_TEMPLATE/issue_hunt.yml
@ -0,0 +1,117 @@
+name: 'Issue Hunt Program'
+description: Create a report to help us improve
+body:
+  - type: checkboxes
+    id: issue_hunt_program
+    attributes:
+      label: Issue Hunt Program (optional)
+      description: |
+        The Issue Hunt Program is an incentive program proposed by AntV to encourage community contributors to participate in the AntV program. For more information, you can refer to the [Issue Hunt Program](https://github.com/antvis/G6/blob/master/ISSUEHUNT.en-US.md).
+        Issues submitted through the Issue Hunt Program are treated the same as regular issues. Regular issues can also be included in the Issue Hunt Program, but they need to be reviewed by the AntV team.
+      options:
+        - label: This issue will participate in the Issue Hunt Program
+    validations:
+      required: false
+  - type: dropdown
+    id: issue_hunt_program
+    attributes:
+      label: Issue Difficulty
+      options:
+        - Low
+        - Medium
+        - High
+    validations:
+      required: false
+  - type: textarea
+    id: bounty_description
+    attributes:
+      label: Bounty
+      description: | 
+        If you are not a program maintainer and are willing to offer a bounty for this issue, you can provide a bounty description here and provide the bounty amount on [IssueHunt](https://oss.issuehunt.io/r/antvis/G6/issues) after submitting the issue.
+        The platform may charge a certain fee, which is unrelated to AntV.
+      placeholder: |
+        Example: I will pay $100 if you can resolve this issue within 24 hours.
+    validations:
+      required: false
+  - type: markdown
+    attributes:
+      value: |
+        Thank you for reporting an issue :pray:.
+
+        This issue tracker is for reporting bugs found in G6 (https://github.com/antvis/G6).
+        If you have a question about how to achieve something and are struggling, please post a question
+        inside of G6's Discussion's tab: https://github.com/antvis/G6/discussions
+
+        Before submitting a new bug/issue, please check the links below to see if there is a solution or question posted there already:
+         - G6's Issue's tab: https://github.com/antvis/G6/pulls?q=is%3Apr+is%3Aopen+sort%3Aupdated-desc
+         - G6's closed issues tab: https://github.com/antvis/G6/issues?q=is%3Aissue+sort%3Aupdated-desc+is%3Aclosed
+         - G6 Discussion's tab: https://github.com/antvis/G6/discussions
+
+        The more information you fill in, the better the community can help you.
+  - type: textarea
+    id: description
+    attributes:
+      label: Describe the bug
+      description: Provide a clear and concise description of the challenge you are running into.
+    validations:
+      required: true
+  - type: input
+    id: link
+    attributes:
+      label: Your Example Website or App
+      description: |
+        Which website or app were you using when the bug happened?
+        Note:
+        - Your bug will may get fixed much faster if we can run your code and it doesn't have dependencies other than the G6 npm package.
+        - To create a shareable code example you can use Stackblitz (https://stackblitz.com/) or CodeSandbox (https://codesandbox.io/s/new). Please no localhost URLs.
+        - Please read these tips for providing a minimal example: https://stackoverflow.com/help/mcve.
+      placeholder: |
+        e.g. Stackblitz, Code Sandbox app url
+    validations:
+      required: true
+  - type: textarea
+    id: steps
+    attributes:
+      label: Steps to Reproduce the Bug or Issue
+      description: Describe the steps we have to take to reproduce the behavior.
+      placeholder: |
+        1. Go to '...'
+        2. Click on '....'
+        3. Scroll down to '....'
+        4. See error
+    validations:
+      required: true
+  - type: textarea
+    id: expected
+    attributes:
+      label: Expected behavior
+      description: Provide a clear and concise description of what you expected to happen.
+      placeholder: |
+        As a user, I expected ___ behavior but i am seeing ___
+    validations:
+      required: true
+  - type: textarea
+    id: screenshots_or_videos
+    attributes:
+      label: Screenshots or Videos
+      description: |
+        If applicable, add screenshots or a video to help explain your problem.
+        For more information on the supported file image/file types and the file size limits, please refer
+        to the following link: https://docs.github.com/en/github/writing-on-github/working-with-advanced-formatting/attaching-files
+      placeholder: |
+        You can drag your video or image files inside of this editor ↓
+  - type: textarea
+    id: platform
+    attributes:
+      label: Platform
+      value: |
+        - OS: [e.g. macOS, Windows, Linux]
+        - Browser: [e.g. Chrome, Safari, Firefox]
+        - Version: [e.g. 91.1]
+    validations:
+      required: true
+  - type: textarea
+    id: additional
+    attributes:
+      label: Additional context
+      description: Add any other context about the problem here.
--- a/.github/ISSUE_TEMPLATE/issue_hunt_chinese.yml
+++ b/.github/ISSUE_TEMPLATE/issue_hunt_chinese.yml
@ -0,0 +1,101 @@
+name: 'Issue Hunt 计划'
+description: 创建一个新的 issue，如果你的 issue 不符合规范，它将会被自动关闭。
+body:
+  - type: checkboxes
+    id: issue_hunt_program
+    attributes:
+      label: Issue Hunt 计划（可选）
+      description: |
+        Issue Hunt 计划是 AntV 为了鼓励社区贡献者参与到 AntV 项目中来，提出的一个激励计划。如果想了解更多，可以查看 [Issue Hunt 计划](https://github.com/antvis/G6/blob/master/ISSUEHUNT.md)
+        通过 Issue Hunt 计划提出的 issue 与普通 issue 无异。普通 issue 也可加入 Issue Hunt 计划，但需要经过 AntV 团队审核。
+      options:
+        - label: 我同意将这个 Issue 参与 Issue Hunt 计划
+    validations:
+      required: false
+  - type: dropdown
+    id: issue_hunt_program
+    attributes:
+      label: Issue 难度
+      options:
+        - 低难度
+        - 中等难度
+        - 高难度
+    validations:
+      required: false
+  - type: textarea
+    id: bounty_description
+    attributes:
+      label: 悬赏
+      description: | 
+        如果您非项目维护者，并愿意对该 issue 悬赏，可以在此处提供悬赏描述，并在提交 Issue 后在 [IssueHunt](https://oss.issuehunt.io/r/antvis/G6/issues) 提供悬赏金额。
+        平台可能会收取一定的手续费，这与 AntV 无关。
+      placeholder: |
+        例如：如果您能够在 24 小时内解决此问题，我将支付 $100。
+    validations:
+      required: false
+  - type: markdown
+    attributes:
+      value: |
+        在提交新 issue 之前，先通过以下链接查看有没有类似的 bug 或者建议:
+         - [G6 Issues](https://github.com/antvis/G6/issues)
+         - [G6 Closed Issues](https://github.com/antvis/G6/issues?q=is%3Aissue+is%3Aclosed)
+         - [G6 Discussions](https://github.com/antvis/G6/discussions)
+  - type: textarea
+    id: description
+    attributes:
+      label: 问题描述
+      description: 简洁清晰地描述你遇到的问题。
+    validations:
+      required: true
+  - type: input
+    id: link
+    attributes:
+      label: 重现链接
+      description: |
+        可以使用 CodeSandbox(https://codesandbox.io/s/new) 或者 StackBlitz(https://stackblitz.com/) 重现你的问题。
+      placeholder: |
+        示例: CodeSandBox 或者 StackBlitz URL
+    validations:
+      required: true
+  - type: textarea
+    id: steps
+    attributes:
+      label: 重现步骤
+      description: 简洁清晰的重现步骤能够帮助我们更迅速地定位问题所在。
+      placeholder: |
+        1.进入页面...
+        2.点击....
+        3.查看错误....
+    validations:
+      required: true
+  - type: textarea
+    id: expected
+    attributes:
+      label: 预期行为
+      description: 描述你期望的结果以及实际的结果。
+      placeholder: |
+        我期望看到...，但我看到了...
+    validations:
+      required: true
+  - type: textarea
+    id: platform
+    attributes:
+      label: 平台
+      value: |
+        - 操作系统: [macOS, Windows, Linux, React Native ...]
+        - 网页浏览器: [Google Chrome, Safari, Firefox]
+        - G6 版本: [4.5.1 ... ]
+    validations:
+      required: true
+  - type: textarea
+    id: screenshots_or_videos
+    attributes:
+      label: 屏幕截图或视频（可选）
+      description: 可以添加屏幕截图或视频帮助你解释问题。
+      placeholder: |
+        可以将你的图片或者视频拖拽到此处↓
+  - type: textarea
+    id: additional
+    attributes:
+      label: 补充说明（可选）
+      description: 比如：遇到这个 bug 的业务场景、上下文。
--- a/.github/workflows/issue_hunt_replay.yml
+++ b/.github/workflows/issue_hunt_replay.yml
@ -0,0 +1,45 @@
+name: Auto Reply to Issue Hunt Program
+on:
+  issues:
+    types: [labeled]
+
+jobs:
+  auto-reply:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Comment on Issue
+        if: ${{ github.event.label.name == 'IH: Reward/悬赏' }}
+        uses: peter-evans/create-or-update-comment@v3
+        with:
+          issue-number: ${{ github.event.issue.number }}
+          body: |
+            请复制以下模板，填写相关信息，然后删除模板中的注释。
+            Please copy the following template, fill in the relevant information, and then delete the comments in the template.
+            ```template
+
+            ## Issue 认领 / Issue Claim
+
+            **贡献者/Contributor**
+
+            > 例如：张三, 李四
+            > For example: John Smith, Sarah Johnson
+
+            **预计完成时间/Estimated Completion Date**
+
+            > 例如：2023-06-06
+            > For example: May 30, 2023
+
+            **联系方式/Contact Information**
+
+            > 例如：contact@email.com
+            > For example: contact@email.com
+
+            **其他信息/Additional Information**
+
+            > 例如：这个 issue 比预期的要复杂，我希望能获得更多的奖励
+            > For example: This issue is more complex than expected, and I hope to receive more reward.
+
+            ```
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
--- a/ISSUEHUNT.en-US.md
+++ b/ISSUEHUNT.en-US.md
@ -0,0 +1,75 @@
+# Issue Hunt Program
+
+## What is the Issue Hunt Program?
+
+The Issue Hunt Program is an incentive program proposed by AntV to encourage community contributors to participate in the AntV project.
+
+## How to Participate in Issue Hunt?
+
+1. Find an issue that interests you. (issue with 'IH: Reward/ reward' tag)
+2. Contribute code to the issue.
+3. Earn rewards.
+
+## How to Find Issues You Like?
+
+- Find issues that interest you on [Issue Hunt](https://oss.issuehunt.io/r/antvis/G6/issues)
+- Find issues you like on [GitHub](https://github.com/antvis/G6/issues?q=is%3Aopen+is%3Aissue+label%3A%22IH%3A+Reward%2F%E6%82%AC%E8%B5%8F%22)
+
+## Set Rewards for Issues
+
+Both project maintainers and community contributors can set rewards for issues.
+
+If you are a project maintainer, you can set the reward amount for an issue by using a label. For example:
+
+`IH: Reward/悬赏`, `$10` means the reward amount for this issue is $10.
+
+If you are a community contributor, you can reward the issue **you proposed** or the issue **you want to be resolved** on [Issue Hunt](https://oss.issuehunt.io/r/antvis/G6/issues).
+
+> ⚠️ Issue Hunt platform may charge a certain fee.。
+
+## Reward Amounts
+
+The reward amounts for project maintainers are divided into three tiers:
+
+- **Low Difficulty**：`$0.5` - `$5`
+  - Simple question replies, documentation modifications, issue resolutions, new feature development
+  - Workload within 2 hours (Evaluated by the project maintainer)
+- **Medium Difficulty**：`$5` - `$10`
+  - Requires some code modifications
+  - Workload within 2 day
+- **High Difficulty**：`$10` - `$50` (no upper limit in principle)
+  - Requires extensive code modifications
+  - Fixes critical and urgent issues
+  - Complex new feature development
+  - Workload within 2 week
+
+## Reward Distribution
+
+If a reward is initiated through the Issue Hunt platform, Issue Hunt will distribute the reward amount to the contributor's account within 7 days after the issue is closed.
+
+If a reward is initiated by a project maintainer through GitHub, we will distribute rewards to closed issues based on the [Milestone](https://github.com/antvis/G6/milestones) schedule. Prior to distribution, we will contact the contributor to confirm the reward amount and distribution method.
+
+## Issue Claiming
+
+To avoid multiple people claiming the same issue simultaneously, you can leave a comment below an issue marked with IH: Reward/悬赏. The project maintainer will reply within 24 hours to confirm if you can claim the issue and add the IH: Claimed/已认领 label to the issue.
+
+Your claiming comment should include the following information (copy and edit the template to reply):
+
+```template
+
+## Issue Claiming
+
+**Contributors**
+> For example: John Smith, Sarah Johnson
+
+**Estimated Completion Date**
+> For example: May 30, 2023
+
+**Contact Information**
+> For example: contact@email.com
+
+**Additional Information**
+> For example: This issue is more complex than expected, and I hope to receive more reward.
+
+
+```
--- a/ISSUEHUNT.md
+++ b/ISSUEHUNT.md
@ -0,0 +1,74 @@
+# Issue Hunt 计划
+
+## 什么是 Issue Hunt 计划?
+
+Issue Hunt 计划是 AntV 为了鼓励社区贡献者参与到 AntV 项目中来，提出的一个激励计划。
+
+## 如何参与 Issue Hunt?
+
+1. 找到你感兴趣的 issue (带有 `IH: Reward/悬赏` 标签的 issue)
+2. 为 issue 贡献代码
+3. 获得奖励
+
+## 如何找到你喜欢的 Issues?
+
+1. 从 [Issue Hunt](https://oss.issuehunt.io/r/antvis/G6/issues) 上找到你感兴趣的 issues
+2. 从 [GitHub](https://github.com/antvis/G6/issues?q=is%3Aopen+is%3Aissue+label%3A%22IH%3A+Reward%2F%E6%82%AC%E8%B5%8F%22) 上找到你喜欢的 issues
+
+## 为 Issues 设置悬赏
+
+项目维护者和社区人员都可以为 issue 设置悬赏。
+
+如果你是项目维护者，你可以在 Issue 上以 Label 的形式设置奖励金额，例如：
+
+`IH: Reward/悬赏`, `$10` 表示这个 Issue 的奖励金额为 10 美元。
+
+如果你是社区工作者，你可以到[Issue Hunt](https://oss.issuehunt.io/r/antvis/G6/issues)上为**你提出的**/**你希望尽快解决的** issue 进行悬赏。
+
+> ⚠️ Issue Hunt 平台可能会收取一定的手续费。
+
+## 激励金额
+
+项目维护者的悬赏金额分为三档：
+
+- **低难度**：`$0.5` - `$5`
+  - 简单的问题答复、文档修改、问题解决、新特性开发
+  - 工作量在 2 小时以内（由项目维护者评估）
+- **中等难度**：`$5` - `$10`
+  - 需要一定的代码修改
+  - 工作量在 2 天以内
+- **高难度**：`$10` - `$50` (原则上不设上限)
+  - 需要大量的代码修改
+  - 严重且紧急的问题修复
+  - 复杂的新特性开发
+  - 工作量在 2 周以内
+
+## 激励发放
+
+如果是通过 Issue Hunt 平台发起的悬赏，Issue Hunt 会在 issue 被关闭后 7 天内将奖励金额发放到贡献者的账户上。
+
+如果是项目维护者通过 GitHub 发起的悬赏，我们会根据 [Milestone](https://github.com/antvis/G6/milestones) 的周期对关闭的 issues 进行奖励发放。发放前我们会联系贡献者确认奖励金额及发放方式。
+
+## 项目认领
+
+为了避免多人同时认领同一个 issue，你可以在被标记了 `IH: Reward/悬赏` 的 issue 下方留言，项目维护者会在 24 小时内回复你是否可以认领该 issue，并在 issue 上添加 `IH: Claimed/已认领` 标签。
+
+你的认领留言应包含以下信息(请复制后编辑回复)：
+
+```template
+
+## Issue 认领
+
+**贡献者**
+> 例如：张三, 李四
+
+**预计完成时间**
+> 例如：2023-06-06
+
+**联系方式**
+> 例如：contact@email.com
+
+**其他信息**
+> 例如：这个 issue 比预期的要复杂，我希望能获得更多的奖励
+
+```