Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add issue templating using issue forms #825

Merged
merged 3 commits into from
Apr 15, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
100 changes: 100 additions & 0 deletions .github/ISSUE_TEMPLATE/01-sdk-bug.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,100 @@
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.
- 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: Minimal Reproduction steps
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.
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 debug output below.
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:
* 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: ''

---
11 changes: 11 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
blank_issues_enabled: true
contact_links:
- name: Question on use of dotnet sdk
url: https://github.com/microsoftgraph/msgraph-sdk-dotnet/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
andrueastman marked this conversation as resolved.
Show resolved Hide resolved
- name: Question 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
Loading