Update GitHub issue templates (#71)

* Update GitHub issue templates
* Update CHANGELOG
This commit is contained in:
Michael Rose 2018-10-02 18:43:23 -04:00 committed by GitHub
parent 32d2aed866
commit 57edaa3e86
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
6 changed files with 119 additions and 12 deletions

View File

@ -1,10 +1,15 @@
---
name: "Bug Report"
about: "Is something not working as expected?"
---
<!-- <!--
Before opening a new issue please: Before opening a new issue please:
- Verify you have the latest versions of Jekyll and Basically Basic - Verify you have the latest versions of Jekyll and Basically Basic
installed by running `bundle update`. installed by running `bundle update`.
- Thoroughly read the theme's documentation at - Thoroughly read the theme's documentation at
https://github.com/mmistakes/jekyll-theme-basically-basic/blob/master/README.md https://github.com/mmistakes/jekyll-theme-basically-basic
- Search all issues at https://github.com/mmistakes/jekyll-theme-basically-basic/issues - Search all issues at https://github.com/mmistakes/jekyll-theme-basically-basic/issues
for solutions and to avoid duplication. for solutions and to avoid duplication.
- Ask for help at https://talk.jekyllrb.com/ - Ask for help at https://talk.jekyllrb.com/
@ -12,12 +17,6 @@
After exhausting these suggestions use the format below. After exhausting these suggestions use the format below.
--> -->
## Description
<!--
Describe the issue or proposed feature enhancement.
-->
## Environment ## Environment
<!-- <!--
@ -34,15 +33,14 @@
- Ruby gem or remote theme version: - Ruby gem or remote theme version:
- Jekyll version: - Jekyll version:
- Git repository URL: - Git repository URL:
- Operating system:
- GitHub Pages hosted (if yes provide URL to site): - GitHub Pages hosted (if yes provide URL to site):
- Operating system:
---
## Expected behavior ## Expected behavior
<!-- <!--
Describe the intended output or what you expected to see. What is it you expected to happen? This should be a description of how the
functionality you tried to use is supposed to work.
--> -->
## Steps to reproduce the behavior ## Steps to reproduce the behavior
@ -61,3 +59,10 @@
Screenshots can also be included if they help illustrate a behavior. Screenshots can also be included if they help illustrate a behavior.
--> -->
## Other
<!--
NOTE: Please provide a code repository, gist, code snippet, sample files,
screenshots, or anything else you think will aid in reproducing the issue.
-->

16
.github/ISSUE_TEMPLATE/documentation.md vendored Normal file
View File

@ -0,0 +1,16 @@
---
name: "Documentation"
about: "Found a typo or something that needs clarification?"
---
<!-- Thanks for taking the time to open an issue and help make the docs better -->
## Motivation
<!-- Why should we update our docs? -->
<!-- What should we do instead? -->
## Suggestion
<!-- What should we do instead? -->

View File

@ -0,0 +1,33 @@
---
name: "Enhancement / Feature Request"
about: "What would make this theme better?"
---
<!--
Before opening a new issue please search all issues at
https://github.com/mmistakes/jekyll-theme-basically-basic/issues
to avoid duplication.
-->
## Summary
<!--
A short explanation of the enhancement or feature.
-->
## Motivation
<!--
Why do you want to see this feature in the theme?
What use cases does it support?
NOTE: This theme has been designed as a base for you to customize and fit
your site's unique needs. If a feature is not something most people will use,
it likely won't be considered. When in doubt ask.
-->
## Drawbacks
<!--
Why should this enhancement or feature **not** be considered?
-->

22
.github/ISSUE_TEMPLATE/support.md vendored Normal file
View File

@ -0,0 +1,22 @@
---
name: "Question"
about: "Having trouble working with the theme?"
---
<!--
Before opening a new issue please:
- Verify you have the latest versions of Jekyll and Basically Basic
installed by running `bundle update`.
- Thoroughly read the theme's documentation at
https://github.com/mmistakes/jekyll-theme-basically-basic
- Search all issues at https://github.com/mmistakes/jekyll-theme-basically-basic/issues
for solutions and to avoid duplication.
- Ask for help at https://talk.jekyllrb.com/
After exhausting these suggestions ask your question below.
NOTE: Please provide a code repository, gist, code snippet, sample files, or
screenshots to triage your issue.
-->

26
.github/PULL_REQUEST_TEMPLATE.md vendored Normal file
View File

@ -0,0 +1,26 @@
<!--
Thanks for creating a Pull Request! Before you submit, please make sure
you've done the following:
- Read the contributing document at https://github.com/mmistakes/jekyll-theme-basically-basic#contributing
-->
<!--
Choose one of the following by uncommenting it:
-->
<!-- This is a bug fix. -->
<!-- This is an enhancement or feature. -->
<!-- This is a documentation change. -->
## Summary
<!--
Provide a description of what your pull request changes.
-->
## Context
<!--
Is this related to any GitHub issue(s)?
-->

View File

@ -5,6 +5,11 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](http://keepachangelog.com/) The format is based on [Keep a Changelog](http://keepachangelog.com/)
and this project adheres to [Semantic Versioning](http://semver.org/). and this project adheres to [Semantic Versioning](http://semver.org/).
## [Unreleased]
### Changed
- Update GitHub issue templates.
## [1.4.1] - 2018-08-07 ## [1.4.1] - 2018-08-07
### Added ### Added