Skip to content

Commit

Permalink
Updated bug report template
Browse files Browse the repository at this point in the history
  • Loading branch information
squidfunk committed Jan 12, 2023
1 parent 798bf99 commit 27831ce
Showing 1 changed file with 8 additions and 7 deletions.
15 changes: 8 additions & 7 deletions .github/ISSUE_TEMPLATE/bug.yml
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,8 @@ body:
Please list all links to the sections of
[our documentation](https://squidfunk.github.io/mkdocs-material) that
are relevant to the bug, in order to show that you have consulted and
thoroughly read it. Additionally, list links to possibly related [issues](https://github.com/squidfunk/mkdocs-material/issues)
thoroughly read it. Additionally, list links to possibly related
[issues](https://github.com/squidfunk/mkdocs-material/issues)
or [discussions](https://github.com/squidfunk/mkdocs-material/discussions)
you encountered when searching our issue tracker.
[More](https://squidfunk.github.io/mkdocs-material/bug-report/#related-links)
Expand All @@ -49,13 +50,13 @@ body:
attributes:
label: Reproduction
description: >-
Please create a __minimal reproduction__ for the bug. First, read our
[reproduction guide](https://squidfunk.github.io/mkdocs-material/bug-report/reproduction/)
Please create a __.zip file__ with a __minimal reproduction__ for the
bug. First, read our [reproduction guide](https://squidfunk.github.io/mkdocs-material/bug-report/reproduction/)
that explains the necessary steps, then use the [built-in info plugin](https://squidfunk.github.io/mkdocs-material/bug-report/reproduction/#creating-a-zip-file) (mandatory) to create a self-contained
.zip file with the reproduction. Without a reproduction, it can be
challenging to fix the bug. [More](https://squidfunk.github.io/mkdocs-material/bug-report/#reproduction)
.zip file with the reproduction. We reserve the right to close issues
without .zip files. [More](https://squidfunk.github.io/mkdocs-material/bug-report/#reproduction)
placeholder: |-
Drag and drop .zip file with reproduction here.
Drag and drop .zip file with minimal reproduction here.
validations:
required: true

Expand Down Expand Up @@ -116,5 +117,5 @@ body:
before submitting this bug report.
required: true
- label: >-
I have attached a [minimal reproduction](https://squidfunk.github.io/mkdocs-material/bug-report/reproduction/).
I have attached a __.zip file__ with a [minimal reproduction](https://squidfunk.github.io/mkdocs-material/bug-report/reproduction/).
required: true

0 comments on commit 27831ce

Please sign in to comment.