Skip to content

File tree

4 files changed

+115
-4
lines changed

4 files changed

+115
-4
lines changed
 

‎.github/ISSUE_TEMPLATE/bug_report.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ about: "Is something not working as expected?"
1414
for solutions and to avoid duplication.
1515
- Ask for help at http://talk.jekyllrb.com/
1616
17-
After exhausting these suggestions use the format below.
17+
If none of the above solved your problem, you can continue below.
1818
-->
1919

2020
## Environment
@@ -25,15 +25,15 @@ about: "Is something not working as expected?"
2525
2626
Issues without a link to a public repository or ZIP file will likely go ignored.
2727
Being able to see your actual files is necessary to troubleshoot, as most
28-
issues stem from invalid/missing YAML Front Matter, a mis-configured _config.sys
28+
issues stem from invalid/missing YAML Front Matter, a mis-configured _config.yml
2929
file, or problematic site content.
3030
-->
3131

3232
- Minimal Mistakes version:
3333
- Ruby gem or remote theme version:
3434
- Jekyll version:
3535
- Git repository URL:
36-
- GitHub Pages hosted (if yes provide URL to site):
36+
- Hosted on GitHub Pages (if yes provide URL to site):
3737
- Operating system:
3838

3939
## Expected behavior
@@ -46,7 +46,7 @@ about: "Is something not working as expected?"
4646
## Steps to reproduce the behavior
4747

4848
<!--
49-
Describe the steps you took for this problem to exist. Such as: you installed
49+
Describe the steps you took for this problem to come up. Such as: you installed
5050
the theme, customized _config.yml, added your own posts, and started up a
5151
Jekyll server locally.
5252

‎.github/ISSUE_TEMPLATE/bug_report.yml

+81
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
1+
name: Bug Report
2+
description: There is something wrong with the theme. 99% of the time you should select Support below.
3+
body:
4+
- type: markdown
5+
attributes:
6+
value: |
7+
Before opening a new issue please:
8+
9+
- Verify you have the latest versions of Jekyll and Minimal Mistakes
10+
installed by running `bundle update`.
11+
- Thoroughly read the theme's documentation at
12+
https://mmistakes.github.io/minimal-mistakes/docs/quick-start-guide/
13+
- Search all issues at https://github.com/mmistakes/minimal-mistakes/issues
14+
for solutions and to avoid duplication.
15+
- Ask for help at https://talk.jekyllrb.com/
16+
17+
If none of the above solved your problem, you can continue below.
18+
19+
- type: textarea
20+
id: environment
21+
attributes:
22+
label: What happened?
23+
description: |
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.yml
30+
file, or problematic site content.
31+
value: |-
32+
- Minimal Mistakes version:
33+
- Ruby gem or remote theme version:
34+
- Jekyll version:
35+
- Git repository URL:
36+
- Hosted on GitHub Pages (if yes provide URL to site):
37+
- Operating system:
38+
validations:
39+
required: true
40+
41+
- type: textarea
42+
id: expected-behavior
43+
attributes:
44+
label: Expected behavior
45+
description: |
46+
Please describe the expected behavior and the actual result you got.
47+
placeholder: >
48+
What is it you expected to happen? This should be a description of how the
49+
functionality you tried to use is supposed to work.
50+
validations:
51+
required: true
52+
53+
- type: textarea
54+
id: steps-to-reproduce
55+
attributes:
56+
label: Steps to reproduce the behavior
57+
description: |
58+
Describe the steps you took for this problem to come up. Such as: you installed
59+
the theme, customized _config.yml, added your own posts, and started up a
60+
Jekyll server locally.
61+
62+
If an error occurred on GitHub Pages when pushing, please test a local version
63+
following these setup instructions:
64+
https://help.github.com/articles/setting-up-your-github-pages-site-locally-with-jekyll/
65+
66+
Then provide a complete log by running `bundle exec jekyll build --trace --verbose`
67+
and include this output in the filed issue.
68+
69+
Screenshots can also be included if they help illustrate a behavior.
70+
validations:
71+
required: true
72+
73+
- type: textarea
74+
id: other
75+
attributes:
76+
label: Other
77+
description: |
78+
Please provide a code repository, gist, code snippet, sample files,
79+
screenshots, or anything else you think will aid in reproducing the issue.
80+
validations:
81+
required: false

‎.github/ISSUE_TEMPLATE/config.yml

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Support
4+
url: https://github.com/mmistakes/minimal-mistakes/discussions
5+
about: Please post your support questions in the Discussions section.
+25
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
name: Documentation
2+
description: Found a typo or something that needs clarification?
3+
body:
4+
- type: markdown
5+
attributes:
6+
value: |
7+
Thanks for taking the time to open an issue and help make the docs better.
8+
9+
- type: textarea
10+
id: motivation
11+
attributes:
12+
label: Motivation
13+
description: |
14+
Why should we update our docs?
15+
validations:
16+
required: true
17+
18+
- type: textarea
19+
id: suggestion
20+
attributes:
21+
label: Suggestion
22+
description: |
23+
What should we do instead?
24+
validations:
25+
required: true

0 commit comments

Comments
 (0)
Please sign in to comment.