Skip to content

Commit 57edaa3

Browse files
mmistakesmmistakes
authored
Update GitHub issue templates (#71)
* Update GitHub issue templates * Update CHANGELOG
1 parent 32d2aed commit 57edaa3

File tree

6 files changed

+119
-12
lines changed

6 files changed

+119
-12
lines changed

‎.github/ISSUE_TEMPLATE.md renamed to ‎.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 17 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,22 @@
1+
---
2+
name: "Bug Report"
3+
about: "Is something not working as expected?"
4+
---
5+
16
<!--
27
Before opening a new issue please:
38
4-
- Verify you have the latest versions of Jekyll and Basically Basic
9+
- Verify you have the latest versions of Jekyll and Basically Basic
510
installed by running `bundle update`.
611
- Thoroughly read the theme's documentation at
7-
https://github.com/mmistakes/jekyll-theme-basically-basic/blob/master/README.md
12+
https://github.com/mmistakes/jekyll-theme-basically-basic
813
- Search all issues at https://github.com/mmistakes/jekyll-theme-basically-basic/issues
914
for solutions and to avoid duplication.
1015
- Ask for help at https://talk.jekyllrb.com/
1116
1217
After exhausting these suggestions use the format below.
1318
-->
1419

15-
## Description
16-
17-
<!--
18-
Describe the issue or proposed feature enhancement.
19-
-->
20-
2120
## Environment
2221

2322
<!--
@@ -34,15 +33,14 @@
3433
- Ruby gem or remote theme version:
3534
- Jekyll version:
3635
- Git repository URL:
37-
- Operating system:
3836
- GitHub Pages hosted (if yes provide URL to site):
39-
40-
---
37+
- Operating system:
4138

4239
## Expected behavior
4340

4441
<!--
45-
Describe the intended output or what you expected to see.
42+
What is it you expected to happen? This should be a description of how the
43+
functionality you tried to use is supposed to work.
4644
-->
4745

4846
## Steps to reproduce the behavior
@@ -61,3 +59,10 @@
6159
6260
Screenshots can also be included if they help illustrate a behavior.
6361
-->
62+
63+
## Other
64+
65+
<!--
66+
NOTE: Please provide a code repository, gist, code snippet, sample files,
67+
screenshots, or anything else you think will aid in reproducing the issue.
68+
-->

‎.github/ISSUE_TEMPLATE/documentation.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
name: "Documentation"
3+
about: "Found a typo or something that needs clarification?"
4+
---
5+
6+
<!-- Thanks for taking the time to open an issue and help make the docs better -->
7+
8+
## Motivation
9+
10+
<!-- Why should we update our docs? -->
11+
12+
<!-- What should we do instead? -->
13+
14+
## Suggestion
15+
16+
<!-- What should we do instead? -->

‎.github/ISSUE_TEMPLATE/feature_request.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
---
2+
name: "Enhancement / Feature Request"
3+
about: "What would make this theme better?"
4+
---
5+
6+
<!--
7+
Before opening a new issue please search all issues at
8+
https://github.com/mmistakes/jekyll-theme-basically-basic/issues
9+
to avoid duplication.
10+
-->
11+
12+
## Summary
13+
14+
<!--
15+
A short explanation of the enhancement or feature.
16+
-->
17+
18+
## Motivation
19+
20+
<!--
21+
Why do you want to see this feature in the theme?
22+
What use cases does it support?
23+
24+
NOTE: This theme has been designed as a base for you to customize and fit
25+
your site's unique needs. If a feature is not something most people will use,
26+
it likely won't be considered. When in doubt ask.
27+
-->
28+
29+
## Drawbacks
30+
31+
<!--
32+
Why should this enhancement or feature **not** be considered?
33+
-->

‎.github/ISSUE_TEMPLATE/support.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
---
2+
name: "Question"
3+
about: "Having trouble working with the theme?"
4+
---
5+
6+
<!--
7+
Before opening a new issue please:
8+
9+
- Verify you have the latest versions of Jekyll and Basically Basic
10+
installed by running `bundle update`.
11+
- Thoroughly read the theme's documentation at
12+
https://github.com/mmistakes/jekyll-theme-basically-basic
13+
- Search all issues at https://github.com/mmistakes/jekyll-theme-basically-basic/issues
14+
for solutions and to avoid duplication.
15+
- Ask for help at https://talk.jekyllrb.com/
16+
17+
After exhausting these suggestions ask your question below.
18+
19+
NOTE: Please provide a code repository, gist, code snippet, sample files, or
20+
screenshots to triage your issue.
21+
-->
22+

‎.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
<!--
2+
Thanks for creating a Pull Request! Before you submit, please make sure
3+
you've done the following:
4+
5+
- Read the contributing document at https://github.com/mmistakes/jekyll-theme-basically-basic#contributing
6+
-->
7+
8+
<!--
9+
Choose one of the following by uncommenting it:
10+
-->
11+
12+
<!-- This is a bug fix. -->
13+
<!-- This is an enhancement or feature. -->
14+
<!-- This is a documentation change. -->
15+
16+
## Summary
17+
18+
<!--
19+
Provide a description of what your pull request changes.
20+
-->
21+
22+
## Context
23+
24+
<!--
25+
Is this related to any GitHub issue(s)?
26+
-->

‎CHANGELOG.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,11 @@ All notable changes to this project will be documented in this file.
55
The format is based on [Keep a Changelog](http://keepachangelog.com/)
66
and this project adheres to [Semantic Versioning](http://semver.org/).
77

8+
## [Unreleased]
9+
10+
### Changed
11+
- Update GitHub issue templates.
12+
813
## [1.4.1] - 2018-08-07
914

1015
### Added

0 commit comments

Comments
 (0)