Skip to content

Commit 28c3346

Browse files
author
Swasti Gupta
committed
Add issues template
1 parent 20a2b47 commit 28c3346

File tree

7 files changed

+163
-90
lines changed

7 files changed

+163
-90
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

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

.github/ISSUE_TEMPLATE/bug_report.yml

Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
name: Bug Report
2+
description: Broken or unintended behavior with the library.
3+
labels: 'bug-unconfirmed'
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
## Before Submitting your Issue
9+
Our GitHub issues are meant exclusively for bug reports and feature requests. For questions about using MSAL for iOS and macOS, please refer to the [common issues and FAQ](https://github.com/AzureAD/microsoft-authentication-library-for-objc/wiki#getting-help-common-issues-and-faq). If your question is not addressed there, we encourage you to utilize Chat with Copilot for further assistance.
10+
For bugs impacting your app in production, please create a support ticket with your Microsoft representative.
11+
12+
- type: markdown
13+
attributes:
14+
value: |
15+
## Issue Details
16+
17+
- type: input
18+
attributes:
19+
label: MSAL Version
20+
description: "Please enter the latest version of MSAL this issue can be reproduced in."
21+
placeholder: "1.3.0"
22+
validations:
23+
required: true
24+
25+
- type: textarea
26+
attributes:
27+
label: Description
28+
description: "Please briefly describe your issue."
29+
validations:
30+
required: true
31+
32+
- type: textarea
33+
attributes:
34+
label: Error Message
35+
description: "Please provide any error message you are receiving and a stack trace."
36+
37+
- type: textarea
38+
attributes:
39+
label: MSAL Logs
40+
description: "Please provide [verbose or trace level log messages](https://learn.microsoft.com/en-us/entra/msal/objc/logging-ios?tabs=objc#logging-levels) from MSAL. For detailed instructions on collecting MSAL logs, refer to our [Logging Guide](https://learn.microsoft.com/en-us/entra/msal/objc/logging-ios?tabs=objc)."
41+
42+
- type: textarea
43+
attributes:
44+
label: Reproduction Steps
45+
description: "Please provide steps to reproduce or a link to a sample which demonstrates this behavior."
46+
placeholder: |
47+
1.
48+
2.
49+
3.
50+
validations:
51+
required: true
52+
53+
- type: textarea
54+
attributes:
55+
label: Expected Behavior
56+
description: "Please describe what you expect the behavior to be."
57+
validations:
58+
required: true
59+
60+
- type: input
61+
attributes:
62+
label: Regression
63+
description: "If this behavior worked before, please enter the last working MSAL version(s)."
64+
placeholder: "1.3.0"
65+
66+
- type: textarea
67+
attributes:
68+
label: Screenshots
69+
description: If applicable, add screenshots to help illustrate the issue. Drag and drop or paste them directly here.
70+
71+
- type: textarea
72+
attributes:
73+
label: Additional context
74+
description: Add any other context about the issue here.
75+
76+
- type: markdown
77+
attributes:
78+
value: "## Security Reporting"
79+
- type: markdown
80+
attributes:
81+
value: |
82+
For **privacy/security** issues, please follow the instructions [here](https://github.com/AzureAD/microsoft-authentication-library-for-objc?tab=readme-ov-file#security-reporting)

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
# *OPTIONAL* Disables the ability to open blank issues without selecting a template
2+
blank_issues_enabled: false
Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
name: Documentation
2+
description: Issues with documentation for the library.
3+
labels: 'documentation-update-needed'
4+
body:
5+
6+
- type: markdown
7+
attributes:
8+
value: |
9+
## Before Submitting Your Issue
10+
If you’ve identified a problem with the documentation or samples in this repository, please consider opening a Pull Request (PR) with the necessary changes.
11+
12+
Please find our contributing doc [here] (https://github.com/AzureAD/microsoft-authentication-library-for-objc?tab=readme-ov-file#contribute).
13+
14+
- type: input
15+
attributes:
16+
label: Documentation Location
17+
description: Please provide a link to the documentation related to this issue.
18+
placeholder: "docs.microsoft.com"
19+
validations:
20+
required: true
21+
22+
- type: textarea
23+
attributes:
24+
label: Description
25+
description: "Please briefly describe your issue."
26+
placeholder: "Describe the issue clearly, including any errors or missing details."
27+
validations:
28+
required: true

.github/ISSUE_TEMPLATE/documentation.md

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

.github/ISSUE_TEMPLATE/feature_request.md

Lines changed: 0 additions & 24 deletions
This file was deleted.
Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
name: Feature request
2+
description: Suggest a new feature for the library.
3+
labels: 'feature-unconfirmed'
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
## Before Submitting your Issue
9+
Our GitHub issues are meant exclusively for bug reports and feature requests. For questions about using MSAL for iOS and macOS, please refer to the [common issues and FAQ](https://github.com/AzureAD/microsoft-authentication-library-for-objc/wiki#getting-help-common-issues-and-faq). If your question is not addressed there, we encourage you to utilize Chat with Copilot for further assistance.
10+
If this feature is essential for your app in production, please create a support ticket with your Microsoft representative.
11+
12+
- type: textarea
13+
attributes:
14+
label: Description
15+
description: "Please briefly describe the feature you are requesting."
16+
placeholder: Provide a high-level summary of the feature.
17+
validations:
18+
required: true
19+
20+
- type: textarea
21+
attributes:
22+
label: Problem Description
23+
description: Is your feature request related to a specific problem? Describe the issue and how it impacts you.
24+
placeholder: Describe the problem and how it affects your use case.
25+
validations:
26+
required: false
27+
28+
- type: textarea
29+
attributes:
30+
label: Proposed Solution
31+
description: Describe the solution you’d like to see implemented.
32+
placeholder: Explain the desired outcome and how it would improve the experience.
33+
validations:
34+
required: false
35+
36+
- type: textarea
37+
attributes:
38+
label: Alternatives Considered
39+
description: Describe any alternative solutions or workarounds you’ve considered.
40+
placeholder: Share other approaches you’ve thought about.
41+
validations:
42+
required: false
43+
44+
- type: textarea
45+
id: additional-context
46+
attributes:
47+
label: Additional Context
48+
description: Provide any other relevant details or screenshots to support your request.
49+
placeholder: Include extra details or visual references if available.
50+
validations:
51+
required: false

0 commit comments

Comments
 (0)