Skip to content

Commit 847d96d

Browse files
committedApr 1, 2018
Update issue template
1 parent 2248a4b commit 847d96d

File tree

1 file changed

+32
-27
lines changed

1 file changed

+32
-27
lines changed
 

‎.github/ISSUE_TEMPLATE.md

+32-27
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,41 @@
11
<!--
2-
Before submitting please search open and closed issues at
3-
https://github.com/mmistakes/minimal-mistakes/issues to avoid duplication.
4-
5-
Feel free to use the following as a template and remove or add fields as you
6-
see fit. You can convert `[ ]` into `[x]` completed check boxes.
2+
Before opening a new issue please:
3+
4+
- Verify you have the latest versions of Jekyll and Minimal Mistakes
5+
installed by running `bundle update`.
6+
- Thoroughly read the theme's documentation at
7+
https://mmistakes.github.io/minimal-mistakes/docs/quick-start-guide/
8+
- Search all issues at https://github.com/mmistakes/minimal-mistakes/issues
9+
for solutions and to avoid duplication.
10+
- Ask for help at https://talk.jekyllrb.com/
11+
12+
After exhausting these suggestions use the format below.
713
-->
814

9-
- [ ] This is a question about using the theme.
10-
- [ ] This is a feature request or enhancement.
11-
- [ ] I believe this to be a bug with the theme.
12-
- [ ] I am using the latest version of the theme.
13-
- [ ] I have updated all gems with `bundle update`.
14-
- [ ] I have tested locally with `bundle exec jekyll build`.
15+
## Description
1516

16-
---
17+
<!--
18+
Describe the issue or proposed feature enhancement.
19+
-->
1720

18-
## Environment informations
21+
## Environment
1922

2023
<!--
21-
Please include theme version, Jekyll version, whether you are hosting with
22-
GitHub Pages, and the operating system you are on or tested with.
24+
Please include theme version, Jekyll version, public git repository, whether
25+
you are hosting with GitHub Pages, and the operating system you tested with.
26+
27+
Issues without a link to a public repository or ZIP file will likely go ignored.
28+
Being able to see your actual files is necessary to troubleshoot, as most
29+
issues stem from invalid/missing YAML Front Matter, a mis-configured _config.sys
30+
file, or problematic site content.
2331
-->
2432

25-
- **Minimal Mistakes version:**
26-
- **Jekyll version:**
27-
- **GitHub Pages hosted:** yes/no
28-
- **Operating system:**
33+
- Minimal Mistakes version:
34+
- Ruby gem or remote theme version:
35+
- Jekyll version:
36+
- Git repository URL:
37+
- Operating system:
38+
- GitHub Pages hosted (if yes provide URL to site):
2939

3040
---
3141

@@ -38,14 +48,9 @@
3848
## Steps to reproduce the behavior
3949

4050
<!--
41-
Include a link to a public repository or ZIP file so that the behavior or bug
42-
can easily be reproduced. Being able to see your actual files helps with
43-
troubleshooting as most issues stem from invalid/missing YAML Front Matter, a
44-
mis-configured _config.sys file, or problematic site content.
45-
46-
Describe the steps you took for this problem to exist. Such as: you cloned the
47-
theme, customized _config.yml, added your own posts, and started up a Jekyll
48-
server locally.
51+
Describe the steps you took for this problem to exist. Such as: you installed
52+
the theme, customized _config.yml, added your own posts, and started up a
53+
Jekyll server locally.
4954
5055
If an error occurred on GitHub Pages when pushing, please test a local version
5156
following these setup instructions:

0 commit comments

Comments
 (0)