1
0
Fork 0
mirror of synced 2024-06-18 22:51:09 -04:00

Update issue templates

Closes #437
This commit is contained in:
Eric Nielsen 2021-08-29 11:26:41 -05:00 committed by GitHub
parent df70a1ca99
commit c021507ac7
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
5 changed files with 63 additions and 30 deletions

View file

@ -1,29 +0,0 @@
For bug reports, please provide the following information:
- [ ] I've checked the [existing issues](https://github.com/zimfw/zimfw/issues?q=is%3Aissue) to make sure I'm not duplicating a report.
- [ ] I've pasted the output of `zimfw info` below.
- [ ] I'm using the [latest version](https://github.com/zimfw/zimfw/releases/latest) of `zimfw`.
- [ ] I was able to reproduce the issue with a clean installation of Zim.
zimfw info
----------
<pre>
# In a terminal, run <b>zimfw info</b>, and paste the output here.
</pre>
Description
-----------
Steps to reproduce
------------------
(The fist 4 steps restart the shell with a clean installation of Zim in a temporary directory.)
1. `cd ${$(mktemp -d):A}`
2. `ZDOTDIR=${PWD} HOME=${PWD} ZIM_HOME=${PWD}/.zim exec zsh`
3. `curl -fsSL https://raw.githubusercontent.com/zimfw/install/master/install.zsh | zsh`
5. `exec zsh`
6. Other steps to reproduce. Use `exec zsh` when restarting the terminal or restarting the shell is needed.
Images or other information
---------------------------

42
.github/ISSUE_TEMPLATE/bug_report.md vendored Normal file
View file

@ -0,0 +1,42 @@
---
name: Bug report
about: Create a report to help us improve
title: ''
labels: bug
assignees: ''
---
- [ ] I've checked the [existing issues](https://github.com/zimfw/zimfw/issues?q=is%3Aissue) and I'm not duplicating a report.
- [ ] I'm using the [latest version](https://github.com/zimfw/zimfw/releases/latest) of `zimfw`.
- [ ] I've checked the [Changelog](https://github.com/zimfw/zimfw/blob/master/CHANGELOG.md) and I'm not being affected by documented changes.
- [ ] I've checked the [📢 Announcements](https://github.com/zimfw/zimfw/discussions/426) and I'm not being affected by announced changes.
- [ ] I was able to reproduce the issue with a clean installation of Zim.
- [ ] I've pasted the output of `zimfw info` below.
**Describe the bug**
A clear and concise description of what the bug is.
**Steps to reproduce**
The fist 4 steps restart the shell with a clean installation of Zim in a temporary directory.
Use `exec zsh` when restarting the terminal or restarting the shell is needed.
1. `cd ${$(mktemp -d):A}`
2. `ZDOTDIR=${PWD} HOME=${PWD} ZIM_HOME=${PWD}/.zim exec zsh`
3. `curl -fsSL https://raw.githubusercontent.com/zimfw/install/master/install.zsh | zsh`
4. `exec zsh`
5. Other steps to reproduce the behavior
6. The current unexpected behavior
**Expected behavior**
A clear and concise description of what you expected to happen.
**Screenshots**
If applicable, add screenshots to help explain your problem.
**zimfw info**
```
# In a terminal, run zimfw info, and paste the output here.
```
**Additional context**
Add any other context about the problem here.

View file

@ -0,0 +1,20 @@
---
name: Feature request
about: Suggest an idea for this project
title: ''
labels: enhancement
assignees: ''
---
**Is your feature request related to a problem? Please describe.**
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
**Describe the solution you'd like**
A clear and concise description of what you want to happen.
**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered.
**Additional context**
Add any other context or screenshots about the feature request here.

View file

@ -1 +0,0 @@
Please follow Zim's [code style guidelines](https://github.com/zimfw/zimfw/wiki/Code-Style-Guide).

View file

@ -0,0 +1 @@
- [ ] I've followed Zim's [code style guidelines](https://github.com/zimfw/zimfw/wiki/Code-Style-Guide).