Skip to content

Commit 419db41

Browse files
authored
Improving the issue template
to improve supportability of the sample
1 parent 418e488 commit 419db41

File tree

1 file changed

+50
-6
lines changed

1 file changed

+50
-6
lines changed

.github/ISSUE_TEMPLATE.md

Lines changed: 50 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -12,21 +12,65 @@ IF SUFFICIENT INFORMATION IS NOT PROVIDED VIA THE FOLLOWING TEMPLATE THE ISSUE M
1212
- [ ] regression (a behavior that used to work and stopped in a new release)
1313
```
1414

15-
### Minimal steps to reproduce
16-
>
15+
## The issue was found for the following scenario:
16+
17+
Please add an 'x' for the scenario(s) where you found an issue
18+
19+
1. [ ] Web app that signs in users
20+
1. [ ] with a work and school account in your organization: [1-WebApp-OIDC/1-1-MyOrg](../1-WebApp-OIDC/1-1-MyOrg)
21+
1. [ ] with any work and school account: [/1-WebApp-OIDC/1-2-AnyOrg](../1-WebApp-OIDC/1-2-AnyOrg)
22+
1. [ ] with any work or school account or Microsoft personal account: [1-WebApp-OIDC/1-3-AnyOrgOrPersonal](../1-WebApp-OIDC/1-3-AnyOrgOrPersonal)
23+
1. [ ] with users in National or sovereign clouds [1-WebApp-OIDC/1-4-Sovereign](../1-WebApp-OIDC/1-4-Sovereign)
24+
1. [ ] with B2C users
25+
1. Web app that calls Microsoft Graph
26+
1. [ ] Calling graph with the Microsoft Graph SDK: [2-WebApp-graph-user/2-1-Call-MSGraph](../2-WebApp-graph-user/2-1-Call-MSGraph)
27+
1. [ ] With specific token caches: [2-WebApp-graph-user/2-2-TokenCache](../2-WebApp-graph-user/2-2-TokenCache)
28+
1. [ ] Calling Microsoft Graph in national clouds: [2-WebApp-graph-user/2-4-Sovereign-Call-MSGraph](../2-WebApp-graph-user/2-4-Sovereign-Call-MSGraph)
29+
1. [ ] Web app calling several APIs [3-WebApp-multi-APIs](../3-WebApp-multi-APIs)
30+
1. [ ] Web app calling your own Web API
31+
1. Web app restricting users
32+
1. [ ] by Roles: [5-WebApp-AuthZ/5-1-Roles](../5-WebApp-AuthZ/5-1-Roles)
33+
1. [ ] by Groups: [5-WebApp-AuthZ/5-2-Groups](../5-WebApp-AuthZ/5-2-Groups)
34+
1. [ ] Deployment to Azure
35+
1. [ ] Other (please describe)
36+
37+
### Repro-ing the issue
38+
39+
**Repro steps**
40+
41+
<!-- the minimal steps to reproduce -->
42+
43+
**Expected behavior**
44+
<!-- A clear and concise description of what you expected to happen (or code).-->
45+
46+
**Actual behavior**
47+
<!-- A clear and concise description of what happens, e.g. exception is thrown, UI freezes -->
48+
49+
**Possible Solution**
50+
<!--- Only if you have suggestions on a fix for the bug -->
51+
52+
**Additional context/ Error codes / Screenshots**
1753

1854
### Any log messages given by the failure
19-
>
55+
Add any other context about the problem here, such as logs.
2056

21-
### Expected/desired behavior
22-
>
57+
- You can enable Middleware diagnostics by uncommenting the following [lines](https://github.com/Azure-Samples/active-directory-aspnetcore-webapp-openidconnect-v2/blob/418e4880ce3307befb25c7af600a886560cadcaa/Microsoft.Identity.Web/StartupHelpers.cs#L81-L83)
58+
- You can enable personally identifiable information in your exceptions to get more information in the open id connect middleware see [Seeing [PII is hidden] in log messages](https://github.com/AzureAD/azure-activedirectory-identitymodel-extensions-for-dotnet/wiki/PII)
59+
- Logging for MSAL.NET is described at [Loggin in MSAL.NET](https://docs.microsoft.com/en-us/azure/active-directory/develop/msal-logging#logging-in-msalnet)
2360

2461
### OS and Version?
2562
> Windows 7, 8 or 10. Linux (which distribution). macOS (Yosemite? El Capitan? Sierra?)
2663
2764
### Versions
28-
>
65+
> of ASP.NET Core, of MSAL.NET
66+
67+
### Attempting to troubleshooting yourself:
2968

69+
- did you go through the README.md in the folder where you found the issue?
70+
- did you go through the documentation:
71+
- [Scenario: Web app that signs in users](https://docs.microsoft.com/en-us/azure/active-directory/develop/scenario-web-app-sign-user-overview)
72+
- [Scenario: Web app that calls web APIs](https://docs.microsoft.com/en-us/azure/active-directory/develop/scenario-web-app-call-api-overview)
73+
3074
### Mention any other details that might be useful
3175

3276
> ---------------------------------------------------------------

0 commit comments

Comments
 (0)