-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(.github): add issue templates and contributing guide
- Loading branch information
Showing
10 changed files
with
316 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,60 @@ | ||
| name: "🐞 Bug 报告" | ||
| description: 提交一个 Bug 报告 | ||
| title: "[Bug]: " | ||
| labels: ["bug"] | ||
| body: | ||
| - type: checkboxes | ||
| id: checks | ||
| attributes: | ||
| label: 开始之前... | ||
| description: 你是否已经做出努力? | ||
| options: | ||
| - label: 你正在使用 PSCompletions 的最新版本。 | ||
| required: true | ||
| - label: 你已经阅读了项目的 README 文件。 | ||
| - label: 你已经查看了 https://pscompletions.pages.dev/ | ||
| - label: 你已经在 [Issues](https://github.com/abgox/PSCompletions/issues) 中搜索相关问题。 | ||
| - type: dropdown | ||
| id: powershell-version | ||
| attributes: | ||
| label: 你正在使用什么 Powershell 版本? | ||
| description: | | ||
| [PowerShell (pwsh)](https://github.com/PowerShell/PowerShell) | ||
| [Windows PowerShell (Windows 内置版本)](https://learn.microsoft.com/powershell/scripting/what-is-windows-powershell) | ||
| options: | ||
| - PowerShell | ||
| - Windows PowerShell | ||
| multiple: true | ||
| validations: | ||
| required: true | ||
| - type: dropdown | ||
| id: system | ||
| attributes: | ||
| label: 你正在使用什么系统环境? | ||
| options: | ||
| - Windows | ||
| - Other system | ||
| multiple: true | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: steps-to-reproduce | ||
| attributes: | ||
| label: bug 复现步骤 | ||
| placeholder: Steps to reproduce | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: expected | ||
| attributes: | ||
| label: 期望结果 | ||
| - type: textarea | ||
| id: actually-happening | ||
| attributes: | ||
| label: 实际发生了什么? | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: additional-info | ||
| attributes: | ||
| label: 还有其他你想要补充的信息吗？ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,60 @@ | ||
| name: "🐞 Bug report" | ||
| description: Create a report to help us improve | ||
| title: "[Bug]: " | ||
| labels: ["bug"] | ||
| body: | ||
| - type: checkboxes | ||
| id: checks | ||
| attributes: | ||
| label: Before Start | ||
| description: Have you verified the following? | ||
| options: | ||
| - label: You are using the latest version of PSCompletions. | ||
| required: true | ||
| - label: You have read this repository's README file. | ||
| - label: You have visit https://pscompletions.pages.dev/ | ||
| - label: You have search for related issues in [Issues](https://github.com/abgox/PSCompletions/issues). | ||
| - type: dropdown | ||
| id: powershell-version | ||
| attributes: | ||
| label: What Powershell version are you using? | ||
| description: | | ||
| [PowerShell (pwsh)](https://github.com/PowerShell/PowerShell) | ||
| [Windows PowerShell (Windows builtin version)](https://learn.microsoft.com/powershell/scripting/what-is-windows-powershell) | ||
| options: | ||
| - PowerShell | ||
| - Windows PowerShell | ||
| multiple: true | ||
| validations: | ||
| required: true | ||
| - type: dropdown | ||
| id: system | ||
| attributes: | ||
| label: What system are you using? | ||
| options: | ||
| - Windows | ||
| - Other system | ||
| multiple: true | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: steps-to-reproduce | ||
| attributes: | ||
| label: Steps to reproduce | ||
| placeholder: Steps to reproduce | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: expected | ||
| attributes: | ||
| label: What is expected? | ||
| - type: textarea | ||
| id: actually-happening | ||
| attributes: | ||
| label: What is actually happening? | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: additional-comments | ||
| attributes: | ||
| label: Any additional comments? |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,31 @@ | ||
| name: ✨ 补全添加请求 | ||
| description: 请求添加新补全 | ||
| title: "[Add Completion Request]: " | ||
| labels: ["feature", "Add Completion"] | ||
| body: | ||
| - type: input | ||
| id: completion | ||
| attributes: | ||
| label: 什么补全需要添加? (如：cli命令等) | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: documentation | ||
| attributes: | ||
| label: 此补全的命令来源 | ||
| description: | | ||
| 此补全来源于什么命令？ | ||
| 请提供命令的官网文档链接，或描述。 | ||
| placeholder: 例如，输入命令的官网文档链接 | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: usage | ||
| attributes: | ||
| label: 请提供可以查看命令用法的地址、方法或描述。 | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: additional-info | ||
| attributes: | ||
| label: 还有其他你想要补充的信息吗？ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,31 @@ | ||
| name: ✨ Add Completion Request | ||
| description: Request to add a new completion | ||
| title: "[Add Completion Request]: " | ||
| labels: ["feature", "Add Completion"] | ||
| body: | ||
| - type: input | ||
| id: completion | ||
| attributes: | ||
| label: What completion need to add? (e.g. cli commands) | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: documentation | ||
| attributes: | ||
| label: Command source for this completion | ||
| description: | | ||
| What command does this completion come from? | ||
| Please provide its official documentation link or description. | ||
| placeholder: Enter the command source link or description here. | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: usage | ||
| attributes: | ||
| label: Please provide a link, method, or description where you can view the command usage. | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: additional-comments | ||
| attributes: | ||
| label: Any additional comments? |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| name: ✨ 补全更新请求 | ||
| description: 请求更新现有补全 | ||
| title: "[Update Completion Request]: " | ||
| labels: ["feature", "Update Completion"] | ||
| body: | ||
| - type: input | ||
| id: completion | ||
| attributes: | ||
| label: 什么补全需要更新? | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: documentation | ||
| attributes: | ||
| label: 其中什么内容需要更新 | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: additional-info | ||
| attributes: | ||
| label: 还有其他你想要补充的信息吗？ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| name: ✨ Update Completion Request | ||
| description: Request to update a new completion | ||
| title: "[Update Completion Request]: " | ||
| labels: ["feature", "Update Completion"] | ||
| body: | ||
| - type: input | ||
| id: completion | ||
| attributes: | ||
| label: What completion need to update? | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: documentation | ||
| attributes: | ||
| label: What content needs to update in it? | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: additional-info | ||
| attributes: | ||
| label: Any additional comments? |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| blank_issues_enabled: false | ||
| contact_links: | ||
| - name: docs | ||
| url: https://pscompletions.pages.dev/ | ||
| about: Visit it for more information. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,42 @@ | ||
| name: 💡 功能请求 | ||
| description: 请求一个新功能或功能增强 | ||
| title: "[Request]: " | ||
| labels: ["feature"] | ||
| body: | ||
| - type: textarea | ||
| id: description | ||
| attributes: | ||
| label: 描述这个功能请求 | ||
| description: | | ||
| 请详细描述您的功能要求或增强。 | ||
| 它解决了 PSCompletions 中的哪些不足? | ||
| 哪些用例支持您的请求? | ||
| validations: | ||
| required: true | ||
| - type: dropdown | ||
| id: powershell-version | ||
| attributes: | ||
| label: 你正在使用什么 Powershell 版本? | ||
| description: | | ||
| [PowerShell (pwsh)](https://github.com/PowerShell/PowerShell) | ||
| [Windows PowerShell (Windows 内置版本)](https://learn.microsoft.com/powershell/scripting/what-is-windows-powershell) | ||
| options: | ||
| - PowerShell | ||
| - Windows PowerShell | ||
| multiple: true | ||
| validations: | ||
| required: true | ||
| - type: dropdown | ||
| id: system | ||
| attributes: | ||
| label: 你正在使用什么系统环境? | ||
| options: | ||
| - Windows | ||
| - Other system | ||
| multiple: true | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: additional-info | ||
| attributes: | ||
| label: 还有其他你想要补充的信息吗？ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,42 @@ | ||
| name: 💡Feature Request | ||
| description: Request a new feature or enhancement | ||
| title: "[Request]: " | ||
| labels: ["feature"] | ||
| body: | ||
| - type: textarea | ||
| id: description | ||
| attributes: | ||
| label: Describe the request | ||
| description: | | ||
| Please describe your feature request or enhancement in detail. | ||
| What deficiency does it address in PSCompletions? | ||
| What use cases support your request? | ||
| validations: | ||
| required: true | ||
| - type: dropdown | ||
| id: powershell-version | ||
| attributes: | ||
| label: What Powershell version are you using? | ||
| description: | | ||
| [PowerShell (pwsh)](https://github.com/PowerShell/PowerShell) | ||
| [Windows PowerShell (Windows builtin version)](https://learn.microsoft.com/powershell/scripting/what-is-windows-powershell) | ||
| options: | ||
| - PowerShell | ||
| - Windows PowerShell | ||
| multiple: true | ||
| validations: | ||
| required: true | ||
| - type: dropdown | ||
| id: system | ||
| attributes: | ||
| label: What system are you using? | ||
| options: | ||
| - Windows | ||
| - Other system | ||
| multiple: true | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: additional-comments | ||
| attributes: | ||
| label: Any additional comments? |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| # Contributing to PSCompletions | ||
|
|
||
| - Please visit the contributing guide: https://pscompletions.pages.dev/contributing/ |