Skip to content

Commit 6c4563a

Browse files
michaeltlombardimichaeltlombardi
committed
(MAINT) Update GitHub templates
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. This change also updates the workflow file to avoid triggering rust build and tests when the PR only edits the issue templates.
1 parent 7404ad8 commit 6c4563a

File tree

4 files changed

+151
-0
lines changed

4 files changed

+151
-0
lines changed

‎.github/ISSUE_TEMPLATE/Bug_Report.yml

Lines changed: 117 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,117 @@
1+
name: Bug report 🐛
2+
description: Report errors or unexpected behavior 🤔
3+
labels:
4+
- Issue-Bug
5+
- Need-Review
6+
body:
7+
- type: checkboxes
8+
attributes:
9+
label: Prerequisites
10+
options:
11+
- label: Write a descriptive title.
12+
required: true
13+
- label: Make sure you are able to repro it on the latest version
14+
required: true
15+
- label: Search the existing issues.
16+
required: true
17+
- type: textarea
18+
attributes:
19+
label: Summary
20+
description: >-
21+
Write a short description of the issue at a high-level.
22+
placeholder: >-
23+
I am experiencing a problem with X.
24+
I think Y should be happening but Z is actually happening.
25+
validations:
26+
required: true
27+
- type: textarea
28+
attributes:
29+
label: Steps to reproduce
30+
description: >
31+
List of steps, sample code, failing test or link to a project that reproduces the behavior.
32+
Make sure you place a stack trace inside a code (```) block to avoid linking unrelated issues.
33+
placeholder: |-
34+
1. Create the following configuration document:
35+
36+
```yaml
37+
# repro.dsc.config.yaml
38+
$schema: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/2023/08/config/document.json
39+
resources:
40+
- name: repro
41+
type: Test/Echo
42+
properties:
43+
output: expected value
44+
```
45+
46+
1. Call the `get` operation on the repro document:
47+
48+
```sh
49+
dsc config get --path ./repro.dsc.config.yaml
50+
```
51+
validations:
52+
required: true
53+
- type: textarea
54+
attributes:
55+
label: Expected behavior
56+
render: console
57+
placeholder: |
58+
dsc config get --path ./repro.dsc.config.yaml
59+
60+
results:
61+
- name: repro
62+
type: Test/Echo
63+
result:
64+
actualState:
65+
output: expected value
66+
messages: []
67+
hadErrors: false
68+
validations:
69+
required: true
70+
- type: textarea
71+
attributes:
72+
label: Actual behavior
73+
render: console
74+
placeholder: |
75+
# Enable debug tracing, which shouldn't contain any private data
76+
dsc -l debug config get --path ./repro.dsc.config.yaml
77+
78+
results:
79+
- name: repro
80+
type: Test/Echo
81+
result:
82+
actualState:
83+
output: other value
84+
messages: []
85+
hadErrors: false
86+
validations:
87+
required: true
88+
- type: textarea
89+
attributes:
90+
label: Error details
91+
description: Paste verbatim output from DSC if it returns an error
92+
render: console
93+
- type: textarea
94+
attributes:
95+
label: Environment data
96+
description: Paste verbatim output from `$PSVersionTable` below.
97+
render: PowerShell
98+
placeholder: PS> $PSVersionTable
99+
validations:
100+
required: true
101+
- type: input
102+
validations:
103+
required: true
104+
attributes:
105+
label: Version
106+
description: >-
107+
Specify the version you're using. Run the `dsc --version` command to get
108+
the current version.
109+
placeholder: 3.0.0-alpha.5
110+
111+
- type: textarea
112+
attributes:
113+
label: Visuals
114+
description: >
115+
Please upload images or animations that can be used to reproduce issues in the area below.
116+
Try the [Steps Recorder](https://support.microsoft.com/en-us/windows/record-steps-to-reproduce-a-problem-46582a9b-620f-2e36-00c9-04e25d784e47)
117+
on Windows or [Screenshot](https://support.apple.com/en-us/HT208721) on macOS.

‎.github/ISSUE_TEMPLATE/Feature_Request.yml

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
name: Feature Request / Idea 🚀
2+
description: >-
3+
Suggest a new feature or improvement (this doesn't mean you have to
4+
implement it)
5+
labels:
6+
- Issue-Enhancement
7+
- Needs Triage
8+
body:
9+
- type: textarea
10+
attributes:
11+
label: Summary of the new feature / enhancement
12+
description: >
13+
A clear and concise description of what the problem is that the
14+
new feature would solve. Try formulating it in user story style
15+
(if applicable).
16+
placeholder: >-
17+
'As a user I want X so that Y...' with X being the being the
18+
action and Y being the value of the action.
19+
validations:
20+
required: true
21+
22+
- type: textarea
23+
attributes:
24+
label: Proposed technical implementation details (optional)
25+
placeholder: >
26+
A clear and concise description of what you want to happen.
27+
Consider providing an example experience with expected result.

‎.github/ISSUE_TEMPLATE/config.yml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Ask a question
4+
url: https://github.com/PowerShell/DSC/discussions/new?category=q-a
5+
about: >-
6+
If you have a question about DSC, the docs, or this project, ask it here.

‎.github/workflows/rust.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ on:
99
- "docs/**"
1010
- "*.md"
1111
- ".vscode/*.json"
12+
- ".github/ISSUE_TEMPLATE/**"
1213

1314
env:
1415
CARGO_TERM_COLOR: always

0 commit comments

Comments
 (0)