Change GitHub issue templates

This commit is contained in:
Michael Rose 2018-09-28 20:45:34 -04:00
parent a7258d4fe4
commit dcdbba835c
6 changed files with 127 additions and 15 deletions

View file

@ -1,15 +1,26 @@
# Contributing
Having trouble working with the theme? Found a typo in the documentation? Interested in adding a feature or [fixing a bug](https://github.com/mmistakes/minimal-mistakes/issues)? Then by all means [submit an issue](https://github.com/mmistakes/minimal-mistakes/issues/new) or [pull request](https://help.github.com/articles/using-pull-requests/). If this is your first pull request, it may be helpful to read up on the [GitHub Flow](https://guides.github.com/introduction/flow/) first.
Having trouble working with the theme? Found a typo in the documentation?
Interested in adding a feature or [fixing a bug](https://github.com/mmistakes/minimal-mistakes/issues)?
Then by all means [submit an issue](https://github.com/mmistakes/minimal-mistakes/issues/new)
or [pull request](https://help.github.com/articles/using-pull-requests/).
If this is your first pull request, it may be helpful to read up on the
[GitHub Flow](https://guides.github.com/introduction/flow/) first.
Minimal Mistakes has been designed as a base for you to customize and fit your site's unique needs. Please keep this in mind when requesting features and/or submitting pull requests. If it's not something that most people will use, I probably won't consider it. When in doubt ask.
Minimal Mistakes has been designed as a base for you to customize and fit your
site's unique needs. Please keep this in mind when requesting features and/or
submitting pull requests. If it's not something that most people will use, I
probably won't consider it. When in doubt ask.
This goes for author sidebar links and "share button" additions -- I have no intention of merging in every possibly option, the essentials are there to get you started :smile:.
This goes for author sidebar links and "share button" additions -- I have no
intention of merging in every possibly option, the essentials are there to get
you started :smile:.
## Pull Requests
When submitting a pull request:
1. Clone the repo.
2. Create a branch off of `master` and give it a meaningful name (e.g. `my-awesome-new-feature`) and describe the feature or fix.
2. Create a branch off of `master` and give it a meaningful name (e.g.
`my-awesome-new-feature`) and describe the feature or fix.
3. Open a pull request on GitHub.

View file

@ -1,3 +1,8 @@
---
name: "Bug Report"
about: "Is something not working as expected?"
---
<!--
Before opening a new issue please:
@ -12,12 +17,6 @@
After exhausting these suggestions use the format below.
-->
## Description
<!--
Describe the issue or proposed feature enhancement.
-->
## Environment
<!--
@ -34,15 +33,14 @@
- Ruby gem or remote theme version:
- Jekyll version:
- Git repository URL:
- Operating system:
- GitHub Pages hosted (if yes provide URL to site):
---
- Operating system:
## 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
@ -61,3 +59,10 @@
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,32 @@
---
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/minimal-mistakes/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 Minimal Mistakes
installed by running `bundle update`.
- Thoroughly read the theme's documentation at
https://mmistakes.github.io/minimal-mistakes/docs/quick-start-guide/
- Search all issues at https://github.com/mmistakes/minimal-mistakes/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/minimal-mistakes#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)?
-->