Skip to content

Commit

Permalink
(chocolatey-community#1754) Add issue forms to use
Browse files Browse the repository at this point in the history
This commit adds new issue forms that need
to be filled out, as well as adding links to the discussion
page for things we do not want to have issues created directly for.
  • Loading branch information
AdmiringWorm committed Feb 14, 2022
1 parent 27e3b98 commit 72396da
Show file tree
Hide file tree
Showing 3 changed files with 172 additions and 0 deletions.
112 changes: 112 additions & 0 deletions .github/ISSUE_TEMPLATE/bug-report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,112 @@
name: Package Bug Report
description: Something went wrong with the installation of a package? Or did you find an unexpected behavior?
title: "(packageName) "
labels: ["01 - _Triaging", "Bug"]
body:
- type: markdown
attributes:
value: |
Thank you for taking the time to fill out this bug report! Please fill out out the necessary information as complete as you can. Remember, it is better to include too much information, than too little.
Additionall, make sure that the issue title starts with the name of the package you was seeing the issue with inside paranthesis.
**Do NOT report Security related issues here, instead use the Report Abuse on the package page instead. See https://docs.chocolatey.org/en-us/information/security#report-issue**
- type: dropdown
id: choco-version
attributes:
label: Chocolatey Version
description: |
What version of Chocolatey do you have installed on the machine that this Bug occured (Check all versions that apply, if there are any other versions you know of that are affected please add this to the Additional Details box further down)?
Do mind that versions older than the latest version that was available 1 year ago will not be supported.
multiple: true
options:
- 0.11.3
- 0.11.2
- 0.11.1
- 0.11.0
- 0.10.15
validations:
required: true
- type: dropdown
id: choco-license
attributes:
label: Chocolatey License
description: |
Select the license that you are using for Chocolatey when you discovered this bug (Open Source users should select None).
options:
- Professional
- Business
- Architect
- MSP
validations:
required: false
- type: input
id: package-version
attributes:
label: Package Version
description: |
Which version of the package did you find this bug for?
placeholder: ex 5.0.0 or 4.0.0 -> 4.1.0 for upgrades.
validations:
required: true
- type: textarea
id: current-behaviour
attributes:
label: Current Behaviour
description: Please provide a concise description of what you are experiencing.
validations:
required: true
- type: textarea
id: expected-behaviour
attributes:
label: Expected Behaviour
description: Please provide a concise description of what you expected to happen.
validations:
required: false
- type: textarea
id: steps
attributes:
label: Steps To Reproduce
description: |
How can we reproduce the behaviour that you are seeing, please include the exact steps that is needed.
If no steps are included, and we are unable to reproduce the issue it may be closed without notice.
placeholder: |
1. In this environment...
2. Run '...'
3. See error...
validations:
required: true
- type: textarea
id: environment
attributes:
label: Environment
description: |
What environment did you encounter the bug in? Operating System, .NET Version, PowerShell Version and the shell/terminal emulator used (ie. PowerShell, CMD).
value: |
- Operating System:
- .NET Version:
- PowerShell Version:
- Shell:
render: markdown
validations:
required: true
- type: textarea
id: logs
attributes:
label: Chocolatey Log
description: |
Include the log that have been created by Chocolatey. If possible it is prefered to be a link to a file located at https://gist.github.com instead of embedded directly inside the issue.
Tip: For standard installations, the Chocolatey log file is located in `C:\ProgramData\chocolatey\logs\chocolatey.log`.
render: shell
validations:
required: true
- type: textarea
id: additional-details
attributes:
label: Anything else?
description: |
Links? References? Anything that will give us more context about the issue you are encountering?
Tip: You cat attach images by clicking this area to highlight it and then drag files in.
validations:
required: false
15 changes: 15 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
blank_issues_enabled: false
contact_links:
- name: Request a new Feature or Enhancement to package.
# This annoying url is used so it can pre-fill some parts of the new discussion that needs to be created.
# Follow the link to see what will be displayed.
url: https://github.com/chocolatey-community/chocolatey-packages/discussions/new?category=ideas&title=(packageName)&body=%3C%21--%20Please%20update%20the%20title%20with%20a%20summary%20of%20the%20feature%20or%20enhancement%20you%20wish%20to%20see.%20The%20discussion%20needs%20to%20be%20prefixed%20with%20the%20package%20name%20inside%20parentheses.%20Give%20as%20many%20details%20to%20the%20feature%20or%20enhancement%20as%20you%20can%2C%20and%20why%20it%20should%20be%20included.%20Think%20of%20it%20as%20trying%20to%20persuade%20someone%20to%20include%2C%20or%20do%20something.%0A%0AIf%20you%20are%20willing%20to%20submit%20a%20pull%20request%20to%20add%20the%20feature%20or%20enhancement%2C%20include%20this%20as%20well%20but%20do%20not%20start%20working%20on%20a%20pull%20request%20until%20a%20repository%20maintainer%20has%20approved%20the%20inclusion%20%28by%20creating%20an%20issue%20with%20a%20reference%20to%20this%20discussion%29.%20Remember%20to%20remove%20this%20comment%20once%20you%20are%20done.%0A%0AREMEMBER%20TO%20REMOVE%20THIS%20COMMENT%20BEFORE%20CONTINUING%20--%3E
about: Open a discussion to request a feature or enhancement be implemented for a specific package.
- name: Request a new package being migrated to this repository.
# This same annoying url is used here as well to pre-fill some parts of the new discussion that needs to be created.
# Follow the link to see what will be displayed.
url: https://github.com/chocolatey-community/chocolatey-packages/discussions/new?category=ideas&title=(packageName)%20Migrate%20package&body=%3C%21--%20DO%20NOT%20OPEN%20A%20DISCUSSION%20ABOUT%20MIGRATING%20A%20PACKAGE%20WITHOUT%20HAVING%20PERMISSIONS%20FROM%20THE%20MAINTAINER%20OF%20THE%20PACKAGE.%20IF%20THE%20PACKAGE%20MAINTAINER%20IS%20UNRESPONSIVE%2C%20FOLLOW%20THE%20NORMAL%20PACKAGE%20TRIAGE%20DOCUMENTATION.%0A%0AInclude%20details%20of%20why%20it%20should%20be%20migrated%20to%20this%20repository%2C%20who%20will%20be%20responsible%20for%20keeping%20it%20up%20to%20date%20and%20who%20will%20fix%20any%20issues%20that%20get%20reported%20%28either%20by%20users%2C%20or%20the%20automated%20checks%20on%20the%20Community%20Repository%29%20--%3E
about: Open a discussion about moving a package you own, or have permission to move over to this repository.
- name: Ask a Question
url: https://github.com/chocolatey-community/chocolatey-packages/discussions/categories/q-a
about: Do you have a question about a specific package, or maybe the repository itself?
45 changes: 45 additions & 0 deletions .github/ISSUE_TEMPLATE/outdated-report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
name: Package Outdated Report
description: A package is outdated and no new version have been submitted for moderation.
title: "(packageName) "
labels: ["01 - _Triaging", "Outdated"]
body:
- type: markdown
attributes:
value: |
Thank you for taking the time to report an outdated package. To validate the request please fill out the necessary items.
Make sure that the title of the issue starts with the package identifier that is outdated, inside paranthesis.
- type: checkboxes
attributes:
label: Checklist
description: Before continuing, make sure that you have done the following.
options:
- label: I have checked the moderation queue that no new version have been submitted (only visible when logged in), or the submitted package version have failed the Automated Checks.
required: true
- label: I have verified that the new version is a stable release.
required: true
- label: I have looked to see if there are any Bug reports that prevents a new version being submitted.
required: true
- label: I have verified the new version have a Windows Binary (Installer, Archive, etc).
required: true
- type: input
id: package-version
attributes:
label: New Software Version
description: Please input the new software version that is available.
validations:
required: true
- type: input
id: download-location
attributes:
label: Download location
description: Please provide the link to where the binary for the package can be downloaded from (Installer, Archive, etc).
validations:
required: false # We don't really expect users to know this, but it will be helpful.
- type: input
id: package-url
attributes:
label: Package Page
description: Please provide the link to the package that is outdated.
validations:
required: false

0 comments on commit 72396da

Please sign in to comment.