From dcdbba835ccec00303cef87cbc1efe5c89cf5ed6 Mon Sep 17 00:00:00 2001 From: Michael Rose Date: Fri, 28 Sep 2018 20:45:34 -0400 Subject: [PATCH] Change GitHub issue templates --- .github/CONTRIBUTING.md | 21 +++++++++--- .../bug_report.md} | 25 +++++++++------ .github/ISSUE_TEMPLATE/documentation.md | 16 ++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 32 +++++++++++++++++++ .github/ISSUE_TEMPLATE/support.md | 22 +++++++++++++ .github/PULL_REQUEST_TEMPLATE.md | 26 +++++++++++++++ 6 files changed, 127 insertions(+), 15 deletions(-) rename .github/{ISSUE_TEMPLATE.md => ISSUE_TEMPLATE/bug_report.md} (83%) create mode 100644 .github/ISSUE_TEMPLATE/documentation.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/ISSUE_TEMPLATE/support.md create mode 100644 .github/PULL_REQUEST_TEMPLATE.md diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 6341d982..5b9b8306 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -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. -3. Open a pull request on GitHub. \ No newline at end of file +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. diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE/bug_report.md similarity index 83% rename from .github/ISSUE_TEMPLATE.md rename to .github/ISSUE_TEMPLATE/bug_report.md index 57b0d6ca..7cba1e85 100644 --- a/.github/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -1,3 +1,8 @@ +--- +name: "Bug Report" +about: "Is something not working as expected?" +--- + -## Description - - - ## Environment ## Steps to reproduce the behavior @@ -61,3 +59,10 @@ Screenshots can also be included if they help illustrate a behavior. --> + +## Other + + \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/documentation.md b/.github/ISSUE_TEMPLATE/documentation.md new file mode 100644 index 00000000..25f111fd --- /dev/null +++ b/.github/ISSUE_TEMPLATE/documentation.md @@ -0,0 +1,16 @@ +--- +name: "Documentation" +about: "Found a typo or something that needs clarification?" +--- + + + +## Motivation + + + + + +## Suggestion + + \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 00000000..8477f636 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,32 @@ +--- +name: "Enhancement / Feature Request" +about: "What would make this theme better?" +--- + + + +## Summary + + + +## Motivation + + + +## Drawbacks + + \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/support.md b/.github/ISSUE_TEMPLATE/support.md new file mode 100644 index 00000000..e29bcfa6 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/support.md @@ -0,0 +1,22 @@ +--- +name: "Question" +about: "Having trouble working with the theme?" +--- + + + diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 00000000..df3d98d9 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,26 @@ + + + + + + + + +## Summary + + + +## Context + + \ No newline at end of file