Skip to content

Commit

Permalink
Update issue forms and add actions/stale
Browse files Browse the repository at this point in the history
Tested in vscode-powershell first, this should help a ton.
  • Loading branch information
andyleejordan committed Nov 16, 2023
1 parent 0fa5751 commit c500ddf
Show file tree
Hide file tree
Showing 7 changed files with 157 additions and 151 deletions.
88 changes: 88 additions & 0 deletions .github/ISSUE_TEMPLATE/bug-report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,88 @@
name: 🐛 Bug report
description: Open an issue about a bug that needs fixing.
labels: ["Issue-Bug", "Needs: Triage"]
body:
- type: checkboxes
attributes:
label: Prerequisites
options:
- label: I have written a descriptive issue title.
required: true
- label: I have searched all [_open and closed_ issues](https://github.com/PowerShell/PowerShellEditorServices/issues?q=is%3Aissue) to ensure it has not already been reported.
- label: I have read the [troubleshooting](https://github.com/PowerShell/vscode-powershell/blob/main/docs/troubleshooting.md) guide.
- label: I am sure this issue is with _PowerShell Editor Services itself_ and does not reproduce in a standalone [PowerShell](https://github.com/PowerShell/PowerShell/issues/new/choose) instance, and is not an issue with my editor.
- label: I have verified that I am using the latest version of PowerShell Editor Services.
- label: If this is a security issue, I have read the [security issue reporting guidance](https://github.com/PowerShell/vscode-powershell/blob/main/SECURITY.md).
- type: textarea
id: summary
attributes:
label: Summary
description: Explain the problem briefly below.
placeholder: I am experiencing a problem with X. I think Y should be happening but Z is actually happening.
validations:
required: true
- type: textarea
id: powershell-version
attributes:
label: PowerShell Version
description: Paste verbatim output from `$PSVersionTable` below. Please double-check that this is the PowerShell version that is running Editor Services.
render: console
placeholder: |
PS> $PSVersionTable
Name Value
---- -----
PSVersion 7.4.0
PSEdition Core
GitCommitId 7.4.0
OS Darwin 20.4.0 Darwin Kernel
Platform Unix
PSCompatibleVersions {1.0, 2.0, 3.0, 4.0…}
PSRemotingProtocolVersion 2.3
SerializationVersion 1.1.0.1
WSManStackVersion 3.0
validations:
required: true
- type: textarea
id: vscode-version
attributes:
label: Editor Version
description: Paste verbatim output from `emacs --version` or `vim --version` etc. below. **Please also describe how you setup the relevant LSP client, such as `eglot` or `vim-lsp` and share your configuration!**
render: console
placeholder: |
PS> emacs --version
GNU Emacs 29.1
...
validations:
required: true
- type: textarea
id: extension-version
attributes:
label: PowerShell Editor Services Version
description: If you have interactive access to the PowerShell host running Editor Services, paste verbatim output of `$psEditor.EditorServicesVersion` below.
render: console
placeholder: |
PS> $psEditor.EditorServicesVersion
Major Minor Build Revision
----- ----- ----- --------
3 14 0 0
validations:
required: true
- type: textarea
id: steps-to-reproduce
attributes:
label: Steps to Reproduce
description: List of steps, sample code, failing test or link to a project that reproduces the behavior. Make sure you place a stack trace inside a code (```) block to avoid linking unrelated issues.
validations:
required: true
- type: textarea
id: visuals
attributes:
label: Visuals
description: Please upload images or animations that can be used to reproduce issues in the area below. Try the [Steps Recorder](https://support.microsoft.com/en-us/windows/record-steps-to-reproduce-a-problem-46582a9b-620f-2e36-00c9-04e25d784e47) on Windows or [Screenshot](https://support.apple.com/en-us/HT208721) on macOS.
- type: textarea
id: logs
attributes:
label: Logs
description: Please upload logs collected by following these [instructions](https://github.com/PowerShell/vscode-powershell/blob/main/docs/troubleshooting.md#logs) for VS Code (otherwise however your editor is setup) in the area below. Be careful to scrub sensitive information!
5 changes: 5 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
blank_issues_enabled: false
contact_links:
- name: 🙋 Ask a question
url: https://aka.ms/powershell-vscode-discord
about: "Find us in #vscode on the PowerShell Community Discord"
26 changes: 26 additions & 0 deletions .github/ISSUE_TEMPLATE/feature-request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
name: ✨ Feature request
description: Open an issue about a potential new feature or improvement.
labels: ["Issue-Enhancement", "Needs: Triage"]
body:
- type: checkboxes
attributes:
label: Prerequisites
options:
- label: I have written a descriptive issue title.
required: true
- label: I have searched all [issues](https://github.com/PowerShell/PowerShellEditorServices/issues?q=is%3Aissue) to ensure it has not already been requested.
required: true
- type: textarea
id: summary
attributes:
label: Summary
description: Explain the feature request below.
placeholder: I would like to do X because it would be useful for Y and I cannot currently do it with Z.
validations:
required: true
- type: textarea
id: proposed-design
attributes:
label: Proposed Design
description: Optionally explain any technical design below.
placeholder: We could accomplish this by extending X to take Y and yield Z.
2 changes: 2 additions & 0 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ version: 2
updates:
- package-ecosystem: nuget
directory: "/"
labels: [ ]
schedule:
interval: weekly
open-pull-requests-limit: 10
Expand All @@ -15,5 +16,6 @@ updates:
- "xunit.*"
- package-ecosystem: github-actions
directory: "/"
labels: [ ]
schedule:
interval: weekly
150 changes: 0 additions & 150 deletions .github/policies/resourceManagement.yml

This file was deleted.

35 changes: 35 additions & 0 deletions .github/workflows/close-stale-issues.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
name: Close Stale Issues

permissions:
issues: write

on:
schedule:
- cron: "*/15 * * * *"

jobs:
stale-resolved-issues:
runs-on: ubuntu-latest
steps:
- uses: actions/stale@v8
name: Close issues labeled as resolved after 1 day of inactivity
with:
any-of-labels: "Resolution-Answered,Resolution-Duplicate,Resolution-External,Resolution-Fixed,Resolution-Inactive"
days-before-stale: 1
days-before-close: 0
close-issue-reason: completed
close-issue-message: "This issue has been labeled as resolved and has not had any activity for one or more days. It has been closed for housekeeping purposes."
stale-feedback-issues:
runs-on: ubuntu-latest
steps:
- uses: actions/stale@v8
name: Close issues labeled as needs feedback after 1 week of inactivity
with:
any-of-labels: "Needs: Author Feedback,Needs: Fix Verification,Needs: Repro Info"
days-before-stale: 2
days-before-close: 5
labels-to-remove-when-stale: "Needs: Maintainer Attention"
labels-to-add-when-unstale: "Needs: Maintainer Attention"
labels-to-remove-when-unstale: "Needs: Author Feedback,Needs: Fix Verification,Needs: Repro Info"
close-issue-reason: completed
close-issue-message: "This issue has been labeled as needing feedback and has not had any activity for one or more weeks. It has been closed for housekeeping purposes."
2 changes: 1 addition & 1 deletion .github/workflows/codeql-analysis.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: "CodeQL"
name: Run CodeQL Analysis

on:
push:
Expand Down

0 comments on commit c500ddf

Please sign in to comment.