Skip to content

Commit

Permalink
Merge pull request #2678 from microsoftgraph/issue-templating
Browse files Browse the repository at this point in the history
Add issue templating using issue forms
  • Loading branch information
fey101 authored Apr 16, 2024
2 parents 20c5f44 + 74513a4 commit 69515a2
Show file tree
Hide file tree
Showing 9 changed files with 162 additions and 126 deletions.
110 changes: 110 additions & 0 deletions .github/ISSUE_TEMPLATE/01-sdk-bug.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,110 @@
name: SDK Bug Report
description: File SDK bug report
labels: ["type:bug", "status:waiting-for-triage"]
body:
- type: markdown
attributes:
value: |
**Thank you for taking the time to fill out this bug report!**
💥Before submitting a new request, please search existing issues to see if an issue already exists.
💥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).
- type: textarea
id: description
attributes:
label: Describe the bug
description: |
Provide a description of the actual behavior observed. If applicable please include any error messages, exception stacktraces or a screenshot.
placeholder: I am trying to do [...] but [...]
validations:
required: true
- type: textarea
id: expected-behavior
attributes:
label: Expected behavior
description: |
A clear and concise description of what you expected to happen.
placeholder: Expected behavior
validations:
required: true
- type: textarea
id: repro-steps
attributes:
label: How to reproduce
description: |
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).
If there's a link to a public repo where the sample code exists, include it too.
placeholder: |
1. Execute `-Mg-` with `...`
2. See error at `...`
validations:
required: true
- type: input
attributes:
label: SDK Version
placeholder: e.g. 5.32.1
description: |
Version of the SDK with the bug described above.
* Please run `Get-Module Microsoft.Graph*` after cmdlet execution and paste the output here.
* If a module cannot be installed or imported, please run `Get-Module -ListAvailable` and paste the output.
validations:
required: false
- type: input
id: regression
attributes:
label: Latest version known to work for scenario above?
description: |
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.
placeholder: version-number
validations:
required: false
- type: textarea
id: known-workarounds
attributes:
label: Known Workarounds
description: |
Please provide a description of any known workarounds.
placeholder: Known Workarounds
validations:
required: false
- type: textarea
id: logs
attributes:
label: Debug output
description: |
Please copy and paste the output when using the `-Debug` flag. This will be automatically formatted into code, so no need for backticks.
Be sure to remove any sensitive information that may be in the logs.
value: |
<details><summary>Click to expand log</summary>
```
<Log output here>
```
</details>
validations:
required: false
- type: textarea
id: configuration
attributes:
label: Configuration
description: |
Please provide more information on your SDK configuration:
* Please run `$PSVersionTable` and paste the output below.
* If running the Docker container image, indicate the tag of the image used and the version of Docker engine.
* What OS and version, and what distro if applicable (Windows 10, Windows 11, MacOS Catalina, Ubuntu 22.04)?
* What is the architecture (x64, x86, ARM, ARM64)?
* Do you know whether it is specific to that configuration?
placeholder: |
- OS:
- architecture:
validations:
required: false
- type: textarea
id: other-info
attributes:
label: Other information
description: |
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.
placeholder: Other information
validations:
required: false
30 changes: 30 additions & 0 deletions .github/ISSUE_TEMPLATE/02-sdk-feature-request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
name: SDK Feature request
description: Request a new feature on the SDK
labels: ["type:feature", "status:waiting-for-triage"]
body:
- type: markdown
attributes:
value: |
**Thank you for taking the time to fill out this feature request form!**
💥Please search to see if an issue already exists for the feature you are requesting.
- type: textarea
attributes:
label: Is your feature request related to a problem? Please describe the problem.
description: A clear and concise description of what the problem is.
placeholder: I am trying to do [...] but [...]
validations:
required: false
- type: textarea
attributes:
label: Describe the solution you'd like.
description: |
A clear and concise description of what you want to happen. Include any alternative solutions you've considered.
validations:
required: true
- type: textarea
attributes:
label: Additional context?
description: |
Add any other context or screenshots about the feature request here.
validations:
required: false
8 changes: 8 additions & 0 deletions .github/ISSUE_TEMPLATE/03-blank-issue.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
name: Blank issue
about: Something that doesn't fit the other categories
title: ''
labels: ["status:waiting-for-triage"]
assignees: ''

---
44 changes: 0 additions & 44 deletions .github/ISSUE_TEMPLATE/bug_report.md

This file was deleted.

14 changes: 14 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
blank_issues_enabled: true
contact_links:
- name: For issues related to authentication and service errors
url: https://learn.microsoft.com/powershell/microsoftgraph/troubleshooting
about: please refer to our troubleshooting guide
- name: Question on use of powershell sdk
url: https://github.com/microsoftgraph/msgraph-sdk-powershell/discussions
about: Please add your question in the discussions section of the repo
- name: Question on use of kiota
url: https://github.com/microsoft/kiota/discussions
about: Please add your question in the discussions section of the repo
- name: Question, bug report or feature Request for the MS Graph API
url: https://aka.ms/msgraphsupport
about: Report an issue or limitation with the MS Graph service APIs
8 changes: 0 additions & 8 deletions .github/ISSUE_TEMPLATE/custom.md

This file was deleted.

20 changes: 0 additions & 20 deletions .github/ISSUE_TEMPLATE/feature_request.md

This file was deleted.

41 changes: 0 additions & 41 deletions .github/ISSUE_TEMPLATE/microsoft-graph-powershell-bug-report.md

This file was deleted.

13 changes: 0 additions & 13 deletions .github/ISSUE_TEMPLATE/service-bug-report-instructions.md

This file was deleted.

0 comments on commit 69515a2

Please sign in to comment.