Skip to content

Commit

Permalink
(MAINT) Update GitHub templates
Browse files Browse the repository at this point in the history
This change copies the default templates for PowerShell repositories
and customizes them for DSC.

In particular, the bug report template is updated to more usefully
reflect errors and issues with DSC, rather than a PowerShell command.

The change includes the feature request template and template config,
because adding any files to the `.github/ISSUE_TEMPLATE` directory
requires all of them to be present - none of the defaults in the
community repository are used when this folder exists.
  • Loading branch information
michaeltlombardi committed Apr 10, 2024
1 parent f2a9b17 commit 124b84a
Show file tree
Hide file tree
Showing 3 changed files with 157 additions and 0 deletions.
124 changes: 124 additions & 0 deletions .github/ISSUE_TEMPLATE/Bug_Report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,124 @@
name: Bug report 🐛
description: Report errors or unexpected behavior 🤔
labels:
- Issue-Bug
- Need-Review
body:
- type: checkboxes
attributes:
label: Prerequisites
options:
- label: Write a descriptive title.
required: true
- label: Make sure you are able to repro it on the latest version
required: true
- label: Search the existing issues.
required: true
- type: textarea
attributes:
label: Summary
description: >-
Write a short description of the issue at a high-level.
placeholder: >-
I am experiencing a problem with X.
I think Y should be happening but Z is actually happening.
validations:
required: true
- type: textarea
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.
placeholder: |-
1. Create the following configuration document:
```yaml
# repro.dsc.config.yaml
$schema: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/2023/08/config/document.json
resources:
- name: repro
type: Test/Echo
properties:
output: expected value
```
1. Call the `get` operation on the repro document:
```sh
dsc config get --path ./repro.dsc.config.yaml
```
validations:
required: true
- type: textarea
attributes:
label: Expected behavior
render: console
placeholder: |
PS> dsc config get --path ./repro.dsc.config.yaml
results:
- name: repro
type: Test/Echo
result:
actualState:
output: expected value
messages: []
hadErrors: false
validations:
required: true
- type: textarea
attributes:
label: Actual behavior
render: console
placeholder: |
PS> dsc config get --path ./repro.dsc.config.yaml
results:
- name: repro
type: Test/Echo
result:
actualState:
output: other value
messages: []
hadErrors: false
validations:
required: true
- type: textarea
attributes:
label: Error details
description: Paste verbatim output from DSC if it returns an error
render: console
- type: textarea
attributes:
label: Environment data
description: Paste verbatim output from `$PSVersionTable` below.
render: PowerShell
placeholder: PS> $PSVersionTable
validations:
required: true
- type: dropdown
validations:
required: true
attributes:
label: Version
description: >-
Specify the version you are using. Run the `dsc --version` command to get
the current version.
options:
- Latest build from `main`
- alpha.5
- alpha.4
- alpha.3
- alpha.2
- alpha.1
default: 1
multiple: false

- type: textarea
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.
27 changes: 27 additions & 0 deletions .github/ISSUE_TEMPLATE/Feature_Request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
name: Feature Request / Idea 🚀
description: >-
Suggest a new feature or improvement (this doesn't mean you have to
implement it)
labels:
- Issue-Enhancement
- Needs Triage
body:
- type: textarea
attributes:
label: Summary of the new feature / enhancement
description: >
A clear and concise description of what the problem is that the
new feature would solve. Try formulating it in user story style
(if applicable).
placeholder: >-
'As a user I want X so that Y...' with X being the being the
action and Y being the value of the action.
validations:
required: true

- type: textarea
attributes:
label: Proposed technical implementation details (optional)
placeholder: >
A clear and concise description of what you want to happen.
Consider providing an example experience with expected result.
6 changes: 6 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
blank_issues_enabled: false
contact_links:
- name: Ask a question
url: https://github.com/PowerShell/DSC/discussions/new?category=q-a
about: >-
If you have a question about DSC, the docs, or this project, ask it here.

0 comments on commit 124b84a

Please sign in to comment.