Skip to content

Commit 86d41a1

Browse files
IgorMinarkara
IgorMinar
authored and
kara
committed
docs: new GitHub Issue templates (angular#26918)
These templates take advatange of github's feature that allows us to define multiple templates and which the UI presents to the user and lets them choose the most appropriate template. The goal of this is to tailor the templates to the templates to various use-cases and bug categories and provide better guidance to developers filing issues which should result in more efficient processing of the issue backlog. PR Close angular#26918
1 parent e6a0c45 commit 86d41a1

File tree

8 files changed

+209
-55
lines changed

8 files changed

+209
-55
lines changed

‎.github/ISSUE_TEMPLATE.md‎

Lines changed: 6 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -1,59 +1,10 @@
1-
<!--
2-
PLEASE HELP US PROCESS GITHUB ISSUES FASTER BY PROVIDING THE FOLLOWING INFORMATION.
1+
🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑
32

4-
ISSUES MISSING IMPORTANT INFORMATION MAY BE CLOSED WITHOUT INVESTIGATION.
5-
-->
3+
Please help us process issues more efficiently by filing an
4+
issue using one of the following templates:
65

7-
## I'm submitting a...
8-
<!-- Check one of the following options with "x" -->
9-
<pre><code>
10-
[ ] Regression (a behavior that used to work and stopped working in a new release)
11-
[ ] Bug report <!-- Please search GitHub for a similar issue or PR before submitting -->
12-
[ ] Performance issue
13-
[ ] Feature request
14-
[ ] Documentation issue or request
15-
[ ] Support request => Please do not submit support request here, instead see https://github.com/angular/angular/blob/master/CONTRIBUTING.md#question
16-
[ ] Other... Please describe:
17-
</code></pre>
6+
https://github.com/angular/angular/issues/new/choose
187

19-
## Current behavior
20-
<!-- Describe how the issue manifests. -->
8+
Thank you!
219

22-
23-
## Expected behavior
24-
<!-- Describe what the desired behavior would be. -->
25-
26-
27-
## Minimal reproduction of the problem with instructions
28-
<!--
29-
For bug reports please provide the *STEPS TO REPRODUCE* and if possible a *MINIMAL DEMO* of the problem via
30-
https://stackblitz.com or similar (you can use this template as a starting point: https://stackblitz.com/fork/angular-gitter).
31-
-->
32-
33-
## What is the motivation / use case for changing the behavior?
34-
<!-- Describe the motivation or the concrete use case. -->
35-
36-
37-
## Environment
38-
39-
<pre><code>
40-
Angular version: X.Y.Z
41-
<!-- Check whether this is still an issue in the most recent Angular version -->
42-
43-
Browser:
44-
- [ ] Chrome (desktop) version XX
45-
- [ ] Chrome (Android) version XX
46-
- [ ] Chrome (iOS) version XX
47-
- [ ] Firefox version XX
48-
- [ ] Safari (desktop) version XX
49-
- [ ] Safari (iOS) version XX
50-
- [ ] IE version XX
51-
- [ ] Edge version XX
52-
53-
For Tooling issues:
54-
- Node version: XX <!-- run `node --version` -->
55-
- Platform: <!-- Mac, Linux, Windows -->
56-
57-
Others:
58-
<!-- Anything else relevant? Operating system version, IDE, package manager, HTTP server, ... -->
59-
</code></pre>
10+
🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑

‎.github/ISSUE_TEMPLATE/1-bug-report.md‎

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
---
2+
name: "\U0001F41EBug report"
3+
about: Report a bug in the Angular Framework
4+
---
5+
<!--🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅
6+
7+
Oh hi there! 😄
8+
9+
To expedite issue processing please search open and closed issues before submitting a new one.
10+
Existing issues often contain information about workarounds, resolution, or progress updates.
11+
12+
🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅-->
13+
14+
15+
# 🐞 bug report
16+
17+
### Affected Package
18+
<!-- Can you pin-point one or more @angular/* packages as the source of the bug? -->
19+
<!-- ✍️edit: --> The issue is caused by package @angular/....
20+
21+
22+
### Is this a regression?
23+
24+
<!-- Did this behavior use to work in the previous version? -->
25+
<!-- ✍️--> Yes, the previous version in which this bug was not present was: ....
26+
27+
28+
### Description
29+
30+
<!-- ✍️--> A clear and concise description of the problem...
31+
32+
33+
## 🔬 Minimal Reproduction
34+
<!--
35+
Please create and share minimal reproduction of the issue starting with this template: https://stackblitz.com/fork/angular-issue-repro2
36+
-->
37+
<!-- ✍️--> https://stackblitz.com/...
38+
39+
<!--
40+
If StackBlitz is not suitable for reproduction of your issue, please create a minimal GitHub repository with the reproduction of the issue. Share the link to the repo below along with step-by-step instructions to reproduce the problem, as well as expected and actual behavior.
41+
-->
42+
43+
## 🔥 Exception or Error
44+
<pre><code>
45+
<!-- If the issue is accompanied by an exception or an error, please share it below: -->
46+
<!-- ✍️-->
47+
48+
</code></pre>
49+
50+
51+
## 🌍 Your Environment
52+
53+
**Angular Version:**
54+
<pre><code>
55+
<!-- run `ng version` and paste output below -->
56+
<!-- ✍️-->
57+
58+
</code></pre>
59+
60+
**Anything else relevant?**
61+
<!-- ✍️Is this a browser specific issue? If so, please specify the browser and version. -->
62+
63+
<!-- ✍️Do any of these matter: operating system, IDE, package manager, HTTP server, ...? If so, please mention it below. -->

‎.github/ISSUE_TEMPLATE/2-feature-request.md‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
---
2+
name: "\U0001F680Feature request"
3+
about: Suggest a feature for Angular Framework
4+
5+
---
6+
<!--🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅
7+
8+
Oh hi there! 😄
9+
10+
To expedite issue processing please search open and closed issues before submitting a new one.
11+
Existing issues often contain information about workarounds, resolution, or progress updates.
12+
13+
🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅-->
14+
15+
16+
# 🚀 feature request
17+
18+
### Releavant Package
19+
<!-- Can you pin-point one or more @angular/* packages the are relevant for this feature request? -->
20+
<!-- ✍️edit: --> This feature request is for @angular/....
21+
22+
23+
### Description
24+
<!-- ✍️--> A clear and concise description of the problem or missing capability...
25+
26+
27+
### Describe the solution you'd like
28+
<!-- ✍️--> If you have a solution in mind, please describe it.
29+
30+
31+
### Describe alternatives you've considered
32+
<!-- ✍️--> Have you considered any alternative solutions or workarounds?

‎.github/ISSUE_TEMPLATE/3-docs-bug.md‎

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
---
2+
name: "📚 Docs or angular.io issue report"
3+
about: Report an issue in Angular's documentation or angular.io application
4+
5+
---
6+
<!--🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅
7+
8+
Oh hi there! 😄
9+
10+
To expedite issue processing please search open and closed issues before submitting a new one.
11+
Existing issues often contain information about workarounds, resolution, or progress updates.
12+
13+
🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅-->
14+
15+
# 📚 Docs or angular.io bug report
16+
17+
### Description
18+
19+
<!-- ✍️edit:--> A clear and concise description of the problem...
20+
21+
22+
## 🔬 Minimal Reproduction
23+
24+
### What's the affected URL?**
25+
<!-- ✍️edit:--> https://angular.io/...
26+
27+
### Reproduction Steps**
28+
<!-- If applicable please list the steps to take to reproduce the issue -->
29+
<!-- ✍️edit:-->
30+
31+
### Expected vs Actual Behavior**
32+
<!-- If applicable please describe the difference between the expected and actual behavior after following the repro steps. -->
33+
<!-- ✍️edit:-->
34+
35+
36+
## 📷Screenshot
37+
<!-- Often a screenshot can help to capture the issue better than a long description. -->
38+
<!-- ✍️upload a screenshot:-->
39+
40+
41+
## 🔥 Exception or Error
42+
<pre><code>
43+
<!-- If the issue is accompanied by an exception or an error, please share it below: -->
44+
<!-- ✍️-->
45+
46+
</code></pre>
47+
48+
49+
## 🌍 Your Environment
50+
51+
### Browser info
52+
<!-- ✍️Is this a browser specific issue? If so, please specify the device, browser, and version. -->
53+
54+
### Anything else relevant?
55+
<!-- ✍️Please provide additional info if necessary. -->

‎.github/ISSUE_TEMPLATE/4-security-issue-disclosure.md‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
---
2+
name: ⚠️ Security issue disclosure
3+
about: Report a security issue in Angular Framework, Material, or CLI
4+
5+
---
6+
7+
🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑
8+
9+
Please read https://angular.io/guide/security#report-issues on how to disclose security related issues.
10+
11+
🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑

‎.github/ISSUE_TEMPLATE/5-support-request.md‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
name: "❓Support request"
3+
about: Questions and requests for support
4+
5+
---
6+
7+
🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑
8+
9+
Please do not file questions or support requests on the GitHub issues tracker.
10+
11+
You can get your questions answered using other communication channels. Please see:
12+
https://github.com/angular/angular/blob/master/CONTRIBUTING.md#question
13+
14+
Thank you!
15+
16+
🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑

‎.github/ISSUE_TEMPLATE/6-angular-cli.md‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
---
2+
name: "\U0001F6E0️Angular CLI"
3+
about: Issues and feature requests for Angular CLI
4+
5+
---
6+
7+
🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑
8+
9+
Please file any Angular CLI issues at: https://github.com/angular/angular-cli/issues/new
10+
11+
For the time being, we keep Angular CLI issues in a separate repository.
12+
13+
🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑

‎.github/ISSUE_TEMPLATE/7-angular-material.md‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
---
2+
name: "\U0001F48EAngular Material"
3+
about: Issues and feature requests for Angular Material
4+
5+
---
6+
7+
🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑
8+
9+
Please file any Angular Material issues at: https://github.com/angular/material2/issues/new
10+
11+
For the time being, we keep Angular Material issues in a separate repository.
12+
13+
🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑

0 commit comments

Comments
 (0)