Skip to content

Commit 9382cfd

Browse files
authored
Merge pull request #41 from WeAreInSpark/docs/issues
docs: Add issue template and config
2 parents 6e8c8e4 + 41db13d commit 9382cfd

4 files changed

Lines changed: 85 additions & 31 deletions

File tree

.github/ISSUE_TEMPLATE.md

Lines changed: 0 additions & 31 deletions
This file was deleted.

.github/ISSUE_TEMPLATE/Bug.yml

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
name: Bug report 🐛
2+
description: Report errors or unexpected behavior 🤔
3+
labels: Needs-Triage
4+
body:
5+
- type: checkboxes
6+
attributes:
7+
label: Prerequisites
8+
options:
9+
- label: Write a descriptive title.
10+
required: true
11+
- label: Make sure you are able to repro it on the [latest released version](https://github.com/WeAreInSpark/AzureDevOpsPowerShellAPI/releases/latest)
12+
required: true
13+
- label: Search the existing issues.
14+
required: true
15+
- type: textarea
16+
attributes:
17+
label: Steps to reproduce
18+
description: >
19+
List of steps, sample code, failing test or link to a project that reproduces the behavior.
20+
Make sure you place a stack trace inside a code (```) block to avoid linking unrelated issues.
21+
placeholder: >
22+
I am experiencing a problem with X.
23+
I think Y should be happening but Z is actually happening.
24+
validations:
25+
required: true
26+
- type: textarea
27+
attributes:
28+
label: Expected behavior
29+
render: console
30+
placeholder: |
31+
PS> 2 + 2
32+
4
33+
validations:
34+
required: true
35+
- type: textarea
36+
attributes:
37+
label: Actual behavior
38+
render: console
39+
placeholder: |
40+
PS> 2 + 2
41+
5
42+
validations:
43+
required: true
44+
- type: textarea
45+
attributes:
46+
label: Error details
47+
description: Paste verbatim output from `Get-Error` if PowerShell returns an error.
48+
render: console
49+
placeholder: PS> Get-Error
50+
- type: textarea
51+
attributes:
52+
label: Environment data
53+
description: Paste verbatim output from `$PSVersionTable` below.
54+
render: powershell
55+
placeholder: PS> $PSVersionTable
56+
validations:
57+
required: true
58+
- type: textarea
59+
attributes:
60+
label: Visuals
61+
description: >
62+
Please upload images or animations that can be used to reproduce issues in the area below.
63+
Try the [Steps Recorder](https://support.microsoft.com/en-us/windows/record-steps-to-reproduce-a-problem-46582a9b-620f-2e36-00c9-04e25d784e47)
64+
on Windows or [Screenshot](https://support.apple.com/en-us/HT208721) on macOS.

.github/ISSUE_TEMPLATE/Feature.yml

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
name: Feature Request / Idea 🚀
2+
description: Suggest a new feature or improvement (this does not mean you have to implement it)
3+
labels: [Issue-Enhancement, Needs-Triage]
4+
body:
5+
- type: textarea
6+
attributes:
7+
label: Summary of the new feature / enhancement
8+
description: >
9+
A clear and concise description of what the problem is that the
10+
new feature would solve. Try formulating it in user story style
11+
(if applicable).
12+
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."
13+
validations:
14+
required: true
15+
- type: textarea
16+
attributes:
17+
label: Proposed technical implementation details (optional)
18+
placeholder: >
19+
A clear and concise description of what you want to happen.
20+
Consider providing an example PowerShell experience with expected result.

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
blank_issues_enabled: false

0 commit comments

Comments
 (0)