Skip to content

Commit 69515a2

Browse files
fey101fey101
authored
Merge pull request #2678 from microsoftgraph/issue-templating
Add issue templating using issue forms
2 parents 20c5f44 + 74513a4 commit 69515a2

9 files changed

+162
-126
lines changed

‎.github/ISSUE_TEMPLATE/01-sdk-bug.yml

Lines changed: 110 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,110 @@
1+
name: SDK Bug Report
2+
description: File SDK bug report
3+
labels: ["type:bug", "status:waiting-for-triage"]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
**Thank you for taking the time to fill out this bug report!**
9+
💥Before submitting a new request, please search existing issues to see if an issue already exists.
10+
💥You may also check whether you can reproduce this issue using the latest released version of [Microsoft.Graph](https://www.powershellgallery.com/packages/Microsoft.Graph) or [Microsoft.Graph.Beta](https://www.powershellgallery.com/packages/Microsoft.Graph.Beta).
11+
- type: textarea
12+
id: description
13+
attributes:
14+
label: Describe the bug
15+
description: |
16+
Provide a description of the actual behavior observed. If applicable please include any error messages, exception stacktraces or a screenshot.
17+
placeholder: I am trying to do [...] but [...]
18+
validations:
19+
required: true
20+
- type: textarea
21+
id: expected-behavior
22+
attributes:
23+
label: Expected behavior
24+
description: |
25+
A clear and concise description of what you expected to happen.
26+
placeholder: Expected behavior
27+
validations:
28+
required: true
29+
- type: textarea
30+
id: repro-steps
31+
attributes:
32+
label: How to reproduce
33+
description: |
34+
Please include minimal steps to reproduce the problem if possible. E.g.: the smallest possible code snippet; or steps to run project in link above. If possible include text as text rather than screenshots (so it shows up in searches).
35+
If there's a link to a public repo where the sample code exists, include it too.
36+
placeholder: |
37+
1. Execute `-Mg-` with `...`
38+
2. See error at `...`
39+
validations:
40+
required: true
41+
- type: input
42+
attributes:
43+
label: SDK Version
44+
placeholder: e.g. 5.32.1
45+
description: |
46+
Version of the SDK with the bug described above.
47+
* Please run `Get-Module Microsoft.Graph*` after cmdlet execution and paste the output here.
48+
* If a module cannot be installed or imported, please run `Get-Module -ListAvailable` and paste the output.
49+
validations:
50+
required: false
51+
- type: input
52+
id: regression
53+
attributes:
54+
label: Latest version known to work for scenario above?
55+
description: |
56+
Did this work in a previous build or release of the SDK or API client? If you can try a previous release or build to find out, that can help us narrow down the problem. If you don't know, that's OK.
57+
placeholder: version-number
58+
validations:
59+
required: false
60+
- type: textarea
61+
id: known-workarounds
62+
attributes:
63+
label: Known Workarounds
64+
description: |
65+
Please provide a description of any known workarounds.
66+
placeholder: Known Workarounds
67+
validations:
68+
required: false
69+
- type: textarea
70+
id: logs
71+
attributes:
72+
label: Debug output
73+
description: |
74+
Please copy and paste the output when using the `-Debug` flag. This will be automatically formatted into code, so no need for backticks.
75+
Be sure to remove any sensitive information that may be in the logs.
76+
value: |
77+
<details><summary>Click to expand log</summary>
78+
```
79+
80+
<Log output here>
81+
82+
```
83+
</details>
84+
validations:
85+
required: false
86+
- type: textarea
87+
id: configuration
88+
attributes:
89+
label: Configuration
90+
description: |
91+
Please provide more information on your SDK configuration:
92+
* Please run `$PSVersionTable` and paste the output below.
93+
* If running the Docker container image, indicate the tag of the image used and the version of Docker engine.
94+
* What OS and version, and what distro if applicable (Windows 10, Windows 11, MacOS Catalina, Ubuntu 22.04)?
95+
* What is the architecture (x64, x86, ARM, ARM64)?
96+
* Do you know whether it is specific to that configuration?
97+
placeholder: |
98+
- OS:
99+
- architecture:
100+
validations:
101+
required: false
102+
- type: textarea
103+
id: other-info
104+
attributes:
105+
label: Other information
106+
description: |
107+
If you have an idea where the problem might lie, let us know that here. Please include any pointers to code, relevant changes, or related issues you know of.
108+
placeholder: Other information
109+
validations:
110+
required: false

‎.github/ISSUE_TEMPLATE/02-sdk-feature-request.yml

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
name: SDK Feature request
2+
description: Request a new feature on the SDK
3+
labels: ["type:feature", "status:waiting-for-triage"]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
**Thank you for taking the time to fill out this feature request form!**
9+
💥Please search to see if an issue already exists for the feature you are requesting.
10+
- type: textarea
11+
attributes:
12+
label: Is your feature request related to a problem? Please describe the problem.
13+
description: A clear and concise description of what the problem is.
14+
placeholder: I am trying to do [...] but [...]
15+
validations:
16+
required: false
17+
- type: textarea
18+
attributes:
19+
label: Describe the solution you'd like.
20+
description: |
21+
A clear and concise description of what you want to happen. Include any alternative solutions you've considered.
22+
validations:
23+
required: true
24+
- type: textarea
25+
attributes:
26+
label: Additional context?
27+
description: |
28+
Add any other context or screenshots about the feature request here.
29+
validations:
30+
required: false

‎.github/ISSUE_TEMPLATE/03-blank-issue.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
---
2+
name: Blank issue
3+
about: Something that doesn't fit the other categories
4+
title: ''
5+
labels: ["status:waiting-for-triage"]
6+
assignees: ''
7+
8+
---

‎.github/ISSUE_TEMPLATE/bug_report.md

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

‎.github/ISSUE_TEMPLATE/config.yml

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
blank_issues_enabled: true
2+
contact_links:
3+
- name: For issues related to authentication and service errors
4+
url: https://learn.microsoft.com/powershell/microsoftgraph/troubleshooting
5+
about: please refer to our troubleshooting guide
6+
- name: Question on use of powershell sdk
7+
url: https://github.com/microsoftgraph/msgraph-sdk-powershell/discussions
8+
about: Please add your question in the discussions section of the repo
9+
- name: Question on use of kiota
10+
url: https://github.com/microsoft/kiota/discussions
11+
about: Please add your question in the discussions section of the repo
12+
- name: Question, bug report or feature Request for the MS Graph API
13+
url: https://aka.ms/msgraphsupport
14+
about: Report an issue or limitation with the MS Graph service APIs

‎.github/ISSUE_TEMPLATE/custom.md

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

‎.github/ISSUE_TEMPLATE/feature_request.md

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

‎.github/ISSUE_TEMPLATE/microsoft-graph-powershell-bug-report.md

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

‎.github/ISSUE_TEMPLATE/service-bug-report-instructions.md

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

0 commit comments

Comments
 (0)