Skip to content

Commit 16bd363

Browse files
authored
docs: update issue templates (#1300)
Updates the bug report and feature request issue templates to give the community more direction on how to fill them out. Most of the boilerplate is copied from angular/angular, and this aligns our tone and organizational style with angular/angular.
1 parent 5809219 commit 16bd363

File tree

2 files changed

+106
-23
lines changed

2 files changed

+106
-23
lines changed

β€Ž.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 76 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,44 @@
11
---
2-
name: Bug report
3-
about: Create a report to help us improve
2+
name: "\U0001F41E Bug report"
3+
about: Report a bug in the Angular Language Service extension, or in the language server.
44
title: ''
55
labels: bug
66
assignees: ''
77

88
---
99

10-
**Describe the bug**
10+
<!--πŸ”…πŸ”…πŸ”…πŸ”…πŸ”…πŸ”…πŸ”…πŸ”…πŸ”…πŸ”…πŸ”…πŸ”…πŸ”…πŸ”…πŸ”…πŸ”…πŸ”…πŸ”…πŸ”…πŸ”…πŸ”…πŸ”…πŸ”…πŸ”…πŸ”…πŸ”…πŸ”…πŸ”…πŸ”…πŸ”…πŸ”…
1111
12-
A clear and concise description of what the bug is.
12+
Oh hi there! πŸ˜„
13+
14+
To expedite issue processing please search open and closed issues before submitting a new one.
15+
Existing issues often contain information about workarounds, resolution, or progress updates.
16+
17+
πŸ”…πŸ”…πŸ”…πŸ”…πŸ”…πŸ”…πŸ”…πŸ”…πŸ”…πŸ”…πŸ”…πŸ”…πŸ”…πŸ”…πŸ”…πŸ”…πŸ”…πŸ”…πŸ”…πŸ”…πŸ”…πŸ”…πŸ”…πŸ”…πŸ”…πŸ”…πŸ”…πŸ”…πŸ”…πŸ”…πŸ”…πŸ”…πŸ”…-->
18+
19+
# 🐞 bug report
20+
21+
### Is this a regression?
22+
23+
<!-- Did this behavior use to work in the previous version? -->
24+
<!-- ✍️--> Yes, the previous version in which this bug was not present was: ....
25+
26+
### Description
27+
28+
<!-- ✍️--> A clear and concise description of the problem...
1329

1430
If the bug is caused or experienced by a particular source code, please provide a minimal
1531
reproduction of that source code.
1632

17-
**To Reproduce**
33+
## Bug Type
34+
What does this bug affect
35+
36+
<!-- Please check the one that applies to this bug report using "x". -->
37+
38+
- [ ] Angular Language Service VSCode extension
39+
- [ ] Angular Language Service server
40+
41+
## Reproduction
1842

1943
Steps to reproduce the behavior:
2044
1. Go to '...'
@@ -26,22 +50,60 @@ Steps to reproduce the behavior:
2650

2751
A clear and concise description of what you expected to happen.
2852

29-
**Logs**
30-
31-
Log file gives us deep insight into the behavior and performance of the extension, so we strongly
32-
recommend you upload it.
53+
### **Logs**
3354

34-
Go to the command palette (Cmd+Shift+P on Mac, Ctrl+Shift+P on Windows), search `Open Angular Server log`
55+
Log file gives us deep insight into the behavior and performance of the extension. If the issue is a performance
56+
problem or an error occured, please provide the output of the log file below.
3557

3658
Set Angular Log level to verbose.
37-
Open settings (File/Preferences/Settings on Windows, Code/Preferences/Settings on Mac), go to Extensions/Angular Language Service, set `angular.log` to `verbose`.
3859

39-
**Screenshots**
60+
<pre><code>
61+
<!-- If the issue is accompanied by log file output, please share it below.
62+
63+
Set the Angular Log level to verbose by opening settings (File/Preferences/Settings on Windows, Code/Preferences/Settings on Mac), go to Extensions/Angular Language Service, set `angular.log` to `verbose`.
64+
65+
To open the log file, go to the command palette (Cmd+Shift+P on Mac, Ctrl+Shift+P on Windows), search `Open Angular Server log`.
66+
67+
Alternatively, if the log file is long, it can be uploaded instead of pasting below. -->
68+
<!-- ✍️-->
69+
70+
</code></pre>
71+
72+
### **Screenshots**
4073

4174
If applicable, add screenshots to help explain your problem.
4275

4376
![Example Screenshot](./output.png)
4477

45-
**Additional context**
78+
## 🌍 Your Environment
79+
**Angular Version:**
80+
<pre><code>
81+
<!-- run `ng version` and paste output below -->
82+
<!-- ✍️-->
83+
84+
</code></pre>
85+
86+
Extension Version:
87+
<pre><code>
88+
<!-- Enter the version of 'Angular Language Service'. Example: v11.2.11 -->
89+
<!-- ✍️-->
90+
91+
</code></pre>
92+
93+
VSCode Version:
94+
<pre><code>
95+
<!-- Open 'About Visual Studio Code' and paste output below -->
96+
<!-- ✍️-->
97+
98+
</code></pre>
99+
100+
Operating System:
101+
<pre><code>
102+
<!-- Example: Windows 10 Version 1703 OS Build 15063.483 -->
103+
<!-- ✍️-->
104+
105+
</code></pre>
106+
107+
**Anything else relevant?**
108+
<!-- ✍️Do any of these matter hardware, other extensions installed, build environment, ...? If so, please mention it below. -->
46109

47-
Add any other context about the problem here.

β€Ž.github/ISSUE_TEMPLATE/feature_request.md

Lines changed: 30 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,45 @@
11
---
2-
name: Feature request
3-
about: Suggest an idea for this project
2+
name: "\U0001F680 Feature request"
3+
about: Suggest a feature for the Angular Language Service extension, or in the language server.
44
title: ''
55
labels: feature
66
assignees: ''
77

88
---
99

1010
**Is your feature request related to a problem? Please describe.**
11+
<!--πŸ”…πŸ”…πŸ”…πŸ”…πŸ”…πŸ”…πŸ”…πŸ”…πŸ”…πŸ”…πŸ”…πŸ”…πŸ”…πŸ”…πŸ”…πŸ”…πŸ”…πŸ”…πŸ”…πŸ”…πŸ”…πŸ”…πŸ”…πŸ”…πŸ”…πŸ”…πŸ”…πŸ”…πŸ”…πŸ”…πŸ”…
1112
12-
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
13+
Oh hi there! πŸ˜„
1314
14-
**Describe the solution you'd like**
15+
To expedite issue processing please search open and closed issues before submitting a new one.
16+
Existing issues often contain information about workarounds, resolution, or progress updates.
1517
16-
A clear and concise description of what you want to happen.
18+
πŸ”…πŸ”…πŸ”…πŸ”…πŸ”…πŸ”…πŸ”…πŸ”…πŸ”…πŸ”…πŸ”…πŸ”…πŸ”…πŸ”…πŸ”…πŸ”…πŸ”…πŸ”…πŸ”…πŸ”…πŸ”…πŸ”…πŸ”…πŸ”…πŸ”…πŸ”…πŸ”…πŸ”…πŸ”…πŸ”…πŸ”…πŸ”…πŸ”…-->
1719

18-
**Describe alternatives you've considered**
1920

20-
A clear and concise description of any alternative solutions or features you've considered.
21+
# πŸš€ feature request
2122

22-
**Additional context**
23+
### Description
24+
<!-- ✍️--> A clear and concise description of the problem or missing capability...
25+
26+
### Feature Type
27+
What does this bug affect
28+
29+
<!-- Please check the one that applies to this bug report using "x". -->
30+
31+
- [ ] Angular Language Service VSCode extension
32+
- [ ] Angular Language Service server
33+
34+
### Describe the solution you'd like
35+
<!-- ✍️--> If you have a solution in mind, please describe it.
36+
37+
38+
### Describe alternatives you've considered
39+
<!-- ✍️--> Have you considered any alternative solutions or workarounds?
40+
41+
42+
### Anything else relevant?
43+
44+
<!-- ✍️Aare screenshots or any other information needed to prvoide context? If so, please mention it below. -->
2345

24-
Add any other context or screenshots about the feature request here.

0 commit comments

Comments
Β (0)