Skip to content

Commit f65f8f2

Browse files
committed
github: Add preliminary issue templates & configuration.
This adds basic issue templates to support the automatic labelling of reported issues, and some structure to guide users towards useful information to report. This doesn't use forms, much like in the main zulip/zulip repository, and also supports filing blank issues, since the structure is not necessary for each case.
1 parent e32ae3e commit f65f8f2

File tree

5 files changed

+127
-0
lines changed

5 files changed

+127
-0
lines changed

.github/ISSUE_TEMPLATE/01_crash.md

+39
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
---
2+
name: Bug report (major)
3+
about: A major bug which significantly impacts usability, eg. an unexpected quit, crash, freeze.
4+
labels: 'bug: crash',
5+
---
6+
7+
### Bug description
8+
9+
10+
11+
<!-- If discussed in #zulip-terminal or another channel on chat.zulip.org, paste link below: -->
12+
13+
14+
### How is the bug triggered?
15+
How can you reproduce the bug?
16+
1.
17+
18+
19+
### Does it produce a 'traceback' or 'exception'?
20+
<!-- Copy/paste it between the ``` lines below: -->
21+
```
22+
23+
24+
```
25+
26+
### How are you running the application?
27+
Please include as many of the following as possible:
28+
- **Zulip-terminal version:**
29+
eg. a specific version (0.7.0), or if running from `main` also ideally the git ref
30+
- **Zulip server version(s):**
31+
eg. Zulip Cloud, the version you are running self-hosted, or the Zulip Community server (chat.zulip.org)
32+
- **Operating system (and version):**
33+
eg. Debian Linux, Ubuntu Linux, macOS, WSL in Windows, Docker
34+
- **Python version (and implementation):**
35+
eg. 3.8, 3.9, 3.10, ... (implementation is likely to be eg. CPython, or PyPy)
36+
37+
If possible, please provide details from the `About` menu: (hotkey: Meta + ?)
38+
(this can provide some of the details above)
39+

.github/ISSUE_TEMPLATE/02_bug.md

+36
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
---
2+
name: Bug report
3+
about: A concrete bug report with steps to reproduce the behavior.
4+
labels: bug,
5+
---
6+
7+
### Bug description
8+
9+
10+
11+
<!-- If discussed in #zulip-terminal or another channel on chat.zulip.org, paste link below: -->
12+
13+
14+
### How is the bug triggered?
15+
How can you reproduce the bug?
16+
1.
17+
18+
19+
### What did you expect to happen?
20+
21+
22+
23+
### How are you running the application?
24+
Please include as many of the following as possible:
25+
- **Zulip-terminal version:**
26+
eg. a specific version (0.7.0), or if running from `main` also ideally the git ref
27+
- **Zulip server version(s):**
28+
eg. Zulip Cloud, the version you are running self-hosted, or the Zulip Community server (chat.zulip.org)
29+
- **Operating system (and version):**
30+
eg. Debian Linux, Ubuntu Linux, macOS, WSL in Windows, Docker
31+
- **Python version (and implementation):**
32+
eg. 3.8, 3.9, 3.10, ... (implementation is likely to be eg. CPython, or PyPy)
33+
34+
If possible, please provide details from the `About` menu: (hotkey: Meta + ?)
35+
(this can provide some of the details above)
36+

.github/ISSUE_TEMPLATE/03_parity.md

+25
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
---
2+
name: Feature request (a missing known Zulip feature)
3+
about: A request for a feature which is missing, but present in another Zulip client (eg. Web/Desktop/mobile).
4+
labels: 'missing feature',
5+
---
6+
7+
### Description of feature missing from another Zulip client
8+
<!-- Is this an entire missing feature? Or part of the feature? -->
9+
10+
11+
12+
<!-- If discussed in #zulip-terminal or another channel on chat.zulip.org, paste link below: -->
13+
14+
15+
### When was this feature first available in Zulip?
16+
If you know:
17+
- **Zulip version:**
18+
(eg. 2.1, 5.0, 8.0, ..., or 'Zulip Cloud today')
19+
- **Zulip feature level:**
20+
(see https://zulip.com/api/changelog)
21+
22+
23+
### Other details
24+
25+

.github/ISSUE_TEMPLATE/04_platform.md

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
name: Feature suggestion
3+
about: A suggestion for an improvement, specific to the capabilities of the terminal environment.
4+
labels: enhancement,
5+
---
6+
7+
<!--
8+
NOTE: If your proposed feature:
9+
1) is already available in Zulip, please use the other issue feature category
10+
2) would be of benefit to Zulip clients generally, please instead report it at:
11+
https://github.com/zulip/zulip/issues/new/choose
12+
-->
13+
14+
### Description of suggested feature
15+
16+
17+
18+
<!-- If discussed in #zulip-terminal or another channel on chat.zulip.org, paste link below: -->
19+

.github/ISSUE_TEMPLATE/config.yml

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
blank_issues_enabled: true
2+
contact_links:
3+
- name: Report broader Zulip issues (beyond Zulip-Terminal)
4+
about: Includes links to best-practices for filing bug reports, feature requests, security vulnerabilities and more.
5+
url: https://github.com/zulip/zulip/issues/new/choose
6+
- name: Not sure?
7+
about: 'Chat with us, using any of the Zulip clients, in #zulip-terminal on the Developer Community server (chat.zulip.org).'
8+
url: https://zulip.com/development-community

0 commit comments

Comments
 (0)