Skip to content

Commit

Permalink
docs(#159): update bug report template
Browse files Browse the repository at this point in the history
  • Loading branch information
jannis-baum committed Aug 9, 2024
1 parent ac888d5 commit 59c5b16
Showing 1 changed file with 25 additions and 11 deletions.
36 changes: 25 additions & 11 deletions .github/ISSUE_TEMPLATE/bug-report.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,25 +7,39 @@ assignees: ''

---

### Describe the bug
[//]: # (Hello and thank you for taking the time to submit a bug report! )

A clear and concise description of what the bug is.
[//]: # (To make sure we can resolve this as quickly as possible, please )
[//]: # (carefully fill out the information requested on this template. )

[//]: # (Hint: Lines that look like these are Markdown comments and won't be )
[//]: # ( visible on the issue after you submit it so you don't need to )
[//]: # ( delete them. )

### Description

[//]: # (A clear and concise description of what the bug is and what you )
[//]: # (expected to happen instead. Feel free to include additional material )
[//]: # (such as screenshots if they contribute to the explanation. )

### To Reproduce

Steps to reproduce the behavior:
[//]: # (A list of steps we can follow to consistently reproduce the bug )

### Context

1. Use version ...
2.
[//]: # (Please fill out the following list )

### Expected behavior
> My operating system is:

Check failure on line 34 in .github/ISSUE_TEMPLATE/bug-report.md

View workflow job for this annotation

GitHub Actions / Lint Markdown

Blank line inside blockquote

.github/ISSUE_TEMPLATE/bug-report.md:34 MD028/no-blanks-blockquote Blank line inside blockquote https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md028.md
A clear and concise description of what you expected to happen.
> Running `viv --version` outputs:
### Screenshots
```txt
output goes here
```

If applicable, add screenshots to help explain your problem.
> I installed Vivify in the following way (e.g. name of the package manager, self-compiled or development mode):

Check failure on line 41 in .github/ISSUE_TEMPLATE/bug-report.md

View workflow job for this annotation

GitHub Actions / Lint Markdown

Line length

.github/ISSUE_TEMPLATE/bug-report.md:41:81 MD013/line-length Line length [Expected: 80; Actual: 112] https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md013.md

Check failure on line 42 in .github/ISSUE_TEMPLATE/bug-report.md

View workflow job for this annotation

GitHub Actions / Lint Markdown

Blank line inside blockquote

.github/ISSUE_TEMPLATE/bug-report.md:42 MD028/no-blanks-blockquote Blank line inside blockquote https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md028.md
### Additional context
> This is what happens when I run `vivify-server` at the absolute installation path instead of `viv` and try to reproduce the problem:

Check failure on line 43 in .github/ISSUE_TEMPLATE/bug-report.md

View workflow job for this annotation

GitHub Actions / Lint Markdown

Line length

.github/ISSUE_TEMPLATE/bug-report.md:43:81 MD013/line-length Line length [Expected: 80; Actual: 134] https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md013.md

Check failure on line 44 in .github/ISSUE_TEMPLATE/bug-report.md

View workflow job for this annotation

GitHub Actions / Lint Markdown

Blank line inside blockquote

.github/ISSUE_TEMPLATE/bug-report.md:44 MD028/no-blanks-blockquote Blank line inside blockquote https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md028.md
Add any other context about the problem here.
> In the following I specify if I use any custom configuration, and if so provide it in its entirety including any additional files referenced there (e.g. CSS or JavaScript):

Check failure on line 45 in .github/ISSUE_TEMPLATE/bug-report.md

View workflow job for this annotation

GitHub Actions / Lint Markdown

Line length

.github/ISSUE_TEMPLATE/bug-report.md:45:81 MD013/line-length Line length [Expected: 80; Actual: 174] https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md013.md

0 comments on commit 59c5b16

Please sign in to comment.