From 47b7c2a5c0d52fcee2cbe0a00db75020ced0ec17 Mon Sep 17 00:00:00 2001 From: da730 Date: Mon, 29 Jan 2024 17:30:07 +0800 Subject: [PATCH] feat: add pr and issue template --- .github/ISSUE_TEMPLATE/bug_report.yml | 102 ++++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 5 ++ .github/ISSUE_TEMPLATE/feaure_request.yml | 38 ++++++++ .github/ISSUE_TEMPLATE/others.md | 7 ++ .github/PULL_REQUEST_TEMPLATE.md | 86 ++++++++++++++++++ .github/PULL_REQUEST_TEMPLATE/pr_cn.md | 84 ++++++++++++++++++ 6 files changed, 322 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/feaure_request.yml create mode 100644 .github/ISSUE_TEMPLATE/others.md create mode 100644 .github/PULL_REQUEST_TEMPLATE.md create mode 100644 .github/PULL_REQUEST_TEMPLATE/pr_cn.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 00000000..8abfd99f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,102 @@ +name: Bug Report +description: Report a bug to @VisActor/VChart +title: '[Bug] ' +labels: [bug] +body: + - type: markdown + attributes: + value: | + The issue list is reserved exclusively for bug reports and feature requests. + + For usage questions, please use the following resources: + + - Read the [docs](https://www.visactor.io/) + - Find in [examples](https://www.visactor.io/) + - Look for / ask questions on [Stack Overflow](https://stackoverflow.com/questions/tagged/visactor) + + For non-technical support or general questions, you can email [xuanhun521@126.com](mailto:xuanhun521@126.com). + + Also try to search for your issue - it may have already been answered or even fixed in the development branch. However, if you find that an old, closed issue still persists in the latest version, you should open a new issue using the form below instead of commenting on the old issue. + + # - type: checkboxes + # attributes: + # label: Is there an existing issue for this? + # description: Please search to see if an issue already exists for the bug you encountered. + # options: + # - label: I have searched the existing issues + # required: true + + - type: input + attributes: + label: Version + description: | + Check if the issue is reproducible with the latest stable version of @VisActor/VChart. + placeholder: | + e.g. 1.0.0 + + validations: + required: true + + - type: input + attributes: + label: Link to Minimal Reproduction + description: | + If the reproduction does not need a build setup, please provide a link to [JSFiddle](https://jsfiddle.net/pfv0azuc/4/),[CodePen](https://codepen.io/kkxxkk2019/pen/KKrMRqa) or [CodeSandbox](https://codesandbox.io/s/the-template-of-visactor-vchart-vl84ww). If it requires a build setup, you can use [CodeSandbox](https://codesandbox.io/s/the-template-of-visactor-vchart-vl84ww) or provide a GitHub repo. + The reproduction should be **minimal** - i.e. it should contain only the bare minimum amount of code needed to show the bug. + Please do not just fill in a random link. The issue will be closed if no valid reproduction is provided. [Why?](https://antfu.me/posts/why-reproductions-are-required) + + validations: + required: true + + - type: textarea + attributes: + label: Steps to Reproduce + description: | + What do we need to do after opening your repo in order to make the bug happen? Clear and concise reproduction instructions are important for us to be able to triage your issue in a timely manner. Note that you can use [Markdown](https://guides.github.com/features/mastering-markdown/) to format lists and code. + + placeholder: | + 1. How do you create the view + 2. What's the spec of view + 3. User interactions before the error happens. + validations: + required: true + + - type: textarea + attributes: + label: Current Behavior + description: A concise description of what you're experiencing. + validations: + required: true + + - type: textarea + attributes: + label: Expected Behavior + description: A concise description of what you expected to happen. + validations: + required: true + + - type: textarea + attributes: + label: Environment + description: | + e.g. + - **OS**: macOS Monterey + - **Browser**: Chrome 96.0.4664.55 + - **Framework** Vue@3 + value: | + - OS: + - Browser: + - Framework: + render: markdown + + validations: + required: false + + - type: textarea + attributes: + label: Any additional comments? + description: | + e.g. some background/context of how you ran into this bug. + + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 00000000..95ee307f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,5 @@ +blank_issues_enabled: false +# contact_links: +# - name: @VisaActor/VChart +# url: https://www.visactor.io/ +# about: Please search question here before opening a new issue diff --git a/.github/ISSUE_TEMPLATE/feaure_request.yml b/.github/ISSUE_TEMPLATE/feaure_request.yml new file mode 100644 index 00000000..0f65b108 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feaure_request.yml @@ -0,0 +1,38 @@ +name: Feature Request +description: Request a new feature from @VisActor/VChart +title: '[Feature] ' +labels: [new-feature] +body: + - type: markdown + attributes: + value: | + The issue list is reserved exclusively for bug reports and feature requests. + + For usage questions, please use the following resources: + + - Read the [docs](https://www.visactor.io/) + - Find in [examples](https://www.visactor.io//) + - Look for / ask questions on [Stack Overflow](https://stackoverflow.com/questions/tagged/visactors) + + For non-technical support or general questions, you can email [xuanhun521@126.com](mailto:xuanhun521@126.com). + + Also try to search for your issue - it may have already been answered or even fixed in the development branch. However, if you find that an old, closed issue still persists in the latest version, you should open a new issue using the form below instead of commenting on the old issue. + + - type: textarea + attributes: + label: What problem does this feature solve? + description: | + Explain your use case, context, and rationale behind this feature request. More importantly, what is the end user experience you are trying to build that led to the need for this feature? + + An important design goal of @VisActor/VChart is keeping the API surface small and straightforward. In general, we only consider adding new features that solve a problem that cannot be easily dealt with using existing APIs (i.e. not just an alternative way of doing things that can already be done). The problem should also be common enough to justify the addition. + + validations: + required: true + + - type: textarea + attributes: + label: What does the proposed API look like? + description: Describe how you propose to solve the problem and provide code samples of how the API would work once implemented. Note that you can use [Markdown](https://docs.github.com/en/github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax) to format your code blocks. + + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/others.md b/.github/ISSUE_TEMPLATE/others.md new file mode 100644 index 00000000..e3818ddf --- /dev/null +++ b/.github/ISSUE_TEMPLATE/others.md @@ -0,0 +1,7 @@ +--- +name: Others +about: Describe this issue's purpose here. +title: '' +labels: '' +assignees: '' +--- diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 00000000..b1cba0ad --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,86 @@ + + +[[中文版模板 / Chinese template](https://github.com/VisActor/VChart/blob/main/.github/PULL_REQUEST_TEMPLATE/pr_cn.md?plain=1)] + +### 🤔 This is a ... + +- [ ] New feature +- [ ] Bug fix +- [ ] TypeScript definition update +- [ ] Bundle size optimization +- [ ] Performance optimization +- [ ] Enhancement feature +- [ ] Refactoring +- [ ] Update dependency +- [ ] Code style optimization +- [ ] Test Case +- [ ] Branch merge +- [ ] Release +- [ ] Site / documentation update +- [ ] Demo update +- [ ] Workflow +- [ ] Other (about what?) + +### 🔗 Related issue link + + + +### 🔗 Related PR link + + + +### 🐞 Bugserver case id + + + +### 💡 Background and solution + + + +### 📝 Changelog + + + +| Language | Changelog | +| ---------- | --------- | +| 🇺🇸 English | | +| 🇨🇳 Chinese | | + +### ☑️ Self-Check before Merge + +⚠️ Please check all items below before requesting a reviewing. ⚠️ + +- [ ] Doc is updated/provided or not needed +- [ ] Demo is updated/provided or not needed +- [ ] TypeScript definition is updated/provided or not needed +- [ ] Changelog is provided or not needed + +--- + + + +### 🚀 Summary + +copilot:summary + +### 🔍 Walkthrough + +copilot:walkthrough diff --git a/.github/PULL_REQUEST_TEMPLATE/pr_cn.md b/.github/PULL_REQUEST_TEMPLATE/pr_cn.md new file mode 100644 index 00000000..6cf3bfa8 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/pr_cn.md @@ -0,0 +1,84 @@ + + +### 🤔 这个分支是... + +- [ ] 新功能 +- [ ] Bug fix +- [ ] Ts 类型更新 +- [ ] 打包优化 +- [ ] 性能优化 +- [ ] 功能增强 +- [ ] 重构 +- [ ] 依赖版本更新 +- [ ] 代码优化 +- [ ] 测试 case 更新 +- [ ] 分支合并 +- [ ] 发布 +- [ ] 网站/文档更新 +- [ ] demo 更新 +- [ ] Workflow +- [ ] 其他 (具体是什么，请补充?) + +### 🔗 相关 issue 链接 + + + +### 🔗 相关的 PR 链接 + + + +### 🐞 Bugserver 用例 id + + + +### 💡 问题的背景&解决方案 + + + +### 📝 Changelog + + + +| Language | Changelog | +| ---------- | --------- | +| 🇺🇸 English | | +| 🇨🇳 Chinese | | + +### ☑️ 自测 + +⚠️ 在提交 PR 之前，请检查一下内容. ⚠️ + +- [ ] 文档提供了，或者更新，或者不需要 +- [ ] Demo 提供了，或者更新，或者不需要 +- [ ] Ts 类型定义提供了，或者更新，或者不需要 +- [ ] Changelog 提供了，或者不需要 + +--- + + + +### 🚀 Summary + +copilot:summary + +### 🔍 Walkthrough + +copilot:walkthrough