Merge pull request #365 from chipzoller/update-issue-templates

Update issue/PR templates

6 files changed, 236 insertions, 34 deletions

diff --git a/.github/ISSUE_TEMPLATE/01-bug_report.yml b/.github/ISSUE_TEMPLATE/01-bug_report.yml
new file mode 100644
index 0000000..4437ce3
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/01-bug_report.yml
@@ -0,0 +1,112 @@
+name: Bug report
+description: Something isn't working correctly with the theme
+title: "[Bug] "
+labels: ["bug"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Before opening a bug report, please search for the behavior in the [existing issues](https://github.com/chipzoller/hugo-clarity/issues).
+
+        If you have a question, please use [GitHub Discussions](https://github.com/chipzoller/hugo-clarity/discussions) rather than posting an issue.
+
+        ---
+
+        Thank you for taking the time to file a bug report! To address this bug as fast as possible, we need some information.
+  - type: checkboxes
+    id: confirm_prereqs
+    attributes:
+      label: "I confirm:"
+      options:
+        - label: "I am running the [extended version of Hugo version 0.91.0 or above](https://github.com/chipzoller/hugo-clarity/blob/master/README.md#prerequisites) installed."
+          required: true
+        - label: "I have read the [theme documentation](https://github.com/chipzoller/hugo-clarity/blob/master/README.md)."
+          required: true
+        - label: "I have used the [example site's config files](https://github.com/chipzoller/hugo-clarity/tree/master/exampleSite/config/_default) as reference."
+          required: true
+        - label: "I have reviewed [other issues in this repository](https://github.com/chipzoller/hugo-clarity/issues) and mine is not recorded."
+          required: true
+  - type: input
+    id: v_hugo
+    attributes:
+      label: Hugo version
+      description: 'Run `hugo version` and paste the output here.'
+    validations:
+      required: true
+  - type: dropdown
+    id: bug_location
+    attributes:
+      label: Where is this bug showing up?
+      options:
+        - "On the command line: Hugo won't build the site and shows warnings or errors."
+        - "In the browser: Hugo builds the site, but something doesn't look right."
+    validations:
+      required: true
+  - type: input
+    id: os
+    attributes:
+      label: Operating system
+      description: For example, iOS 14, Windows 10, macOS 12.5, Linux Ubuntu 22.04, Android 12, etc.
+    validations:
+      required: true
+  - type: input
+    id: browser
+    attributes:
+      label: Browser (if applicable)
+      description: For example, Chrome 76, Safari 13, etc.
+  - type: textarea
+    id: current_behavior
+    attributes:
+      label: Current behavior
+      description: 
+        Describe how the bug shows up. You can also provide a link to a repo
+        or a live website, or include screenshots.
+    validations:
+      required: true
+  - type: textarea
+    id: expected_behavior
+    attributes:
+      label: Expected behavior
+      description: Describe what you expect the behavior to be without the bug.
+    validations:
+      required: true
+  - type: textarea
+    id: steps_to_reproduce
+    attributes:
+      label: Steps to reproduce
+      description: Explain the steps required to duplicate the bug.
+    validations:
+      required: true
+  - type: textarea
+    id: logs
+    attributes:
+      label: Relevant log output
+      description:
+        If applicable, provide any errors, stacktraces or other output from Hugo.
+      render: shell
+  - type: textarea
+    id: related_code
+    attributes:
+      label: Related code
+      description:
+        If you have already identified the file or lines in the existing code
+        that may be relevant to this bug, providing them will help speed up
+        our response.
+  - type: textarea
+    id: solution
+    attributes:
+      label: Preferred solution
+      description:
+        If you have a suggested technical solution to this bug, please describe
+        it here.
+  - type: textarea
+    id: other_info
+    attributes:
+      label: Other information
+      description: Any other information that might be relevant to this bug.
+  - type: markdown
+    attributes:
+      value: |
+        ---
+
+        **Thank you!**
diff --git a/.github/ISSUE_TEMPLATE/02-feature_request.yml b/.github/ISSUE_TEMPLATE/02-feature_request.yml
new file mode 100644
index 0000000..0ef1fc4
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/02-feature_request.yml
@@ -0,0 +1,69 @@
+name: Feature request
+description: Suggest a new feature for the theme
+title: "[Feature] "
+labels: ["enhancement"]
+body:
+  - type: checkboxes
+    id: confirm_prereqs
+    attributes:
+      label: "I confirm:"
+      options:
+        - label: "I have read the [theme documentation](https://github.com/chipzoller/hugo-clarity/blob/master/README.md)."
+          required: true
+        - label: "I have reviewed [other issues in this repository](https://github.com/chipzoller/hugo-clarity/issues), and this feature has not already been requested."
+          required: true
+  - type: checkboxes
+    id: feature_type
+    attributes:
+      label: Type of feature (check all that apply)
+      options:
+        - label: Site functionality
+        - label: Design (styling)
+        - label: Site performance
+        - label: Accessibility
+        - label: Translations and internationalization (i18n)
+        - label: Code improvements
+        - label: Other (please describe below)
+  - type: textarea
+    id: feature_description
+    attributes:
+      label: Describe the feature
+      description:
+        A clear and concise description of your feature request. Please note if
+        your request is related to a problem or existing bug.
+    validations:
+      required: true
+  - type: textarea
+    id: solution
+    attributes:
+      label: Preferred solution
+      description:
+        If you have a specific way to implement this feature, please describe
+        it here.
+    validations:
+      required: false
+  - type: textarea
+    id: alternatives
+    attributes:
+      label: Alternatives
+      description: Any alternatives you've considered.
+    validations:
+      required: false
+  - type: textarea
+    id: context
+    attributes:
+      label: Additional Context
+      description: Any additional context for this feature request.
+      placeholder: 
+        This could include examples of this feature in websites or other Hugo
+        themes, links to blog posts or other documentation of this feature or
+        descriptions about why it would be a useful addition, use cases or
+        problem statements, etc.
+    validations:
+      required: false
+  - type: markdown
+    attributes:
+      value: |
+        ---
+
+        **Thank you!**
diff --git a/.github/ISSUE_TEMPLATE/03-docs_update.yml b/.github/ISSUE_TEMPLATE/03-docs_update.yml
new file mode 100644
index 0000000..b65eb65
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/03-docs_update.yml
@@ -0,0 +1,19 @@
+name: Documentation change
+description: Suggest a change to theme documentation
+title: "[Docs] "
+labels: ["documentation"]
+body:
+  - type: textarea
+    id: description
+    attributes:
+      label: Describe the change
+      description:
+        Summarize your suggested changes to the documentation.
+    validations:
+      required: true
+  - type: markdown
+    attributes:
+      value: |
+        ---
+
+        **Thank you!**
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
deleted file mode 100644
index 94685da..0000000
--- a/.github/ISSUE_TEMPLATE/bug_report.md
+++ /dev/null
@@ -1,25 +0,0 @@
----
-name: Bug report
-about: Report an issue to help us improve the theme
-title: ''
-labels: ''
-assignees: ''
-
----
-
-**I have checked all the prerequisites below and I'm yet experiencing a problem**
-
-- [ ] Read the README.md
-- [ ] Have the extended version of Hugo installed
-- [ ] Used the exampleSite's config.toml as a reference
-- [ ] I have included my repository link. Instead of pasting long snippets here.
-
-**Describe the bug**
-
-A clear and CONCISE description of what the bug is. [REPLACE]
-
-> Avoid long-winded descriptions
-
-**Desktop (please complete the following information):**
- - OS: [e.g. iOS 14, Windows 10]
- - Browser [e.g. chrome 76, safari 13]
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
new file mode 100644
index 0000000..e7db5a4
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/config.yml
@@ -0,0 +1,10 @@
+blank_issues_enabled: false
+contact_links:
+  - name: Read Hugo Clarity documentation
+    url: https://github.com/chipzoller/hugo-clarity/blob/master/README.md
+    about:
+      If you're new to Hugo Clarity, check our docs for configuration details and 
+      other information.
+  - name: Theme contribution guide
+    url: https://github.com/chipzoller/hugo-clarity/blob/master/CONTRIBUTING.md
+    about: Help us make this theme great!
\ No newline at end of file
diff --git a/.github/pull-request_template.md b/.github/pull-request_template.md
index f605cca..6c42d36 100644
--- a/.github/pull-request_template.md
+++ b/.github/pull-request_template.md
@@ -1,17 +1,34 @@
-This PR...
+<!--- Please provide a general summary of your changes in the title above -->
 
-## Changes / fixes
+## Pull Request type
 
--
+<!-- To ensure we're able to review your PR quickly, limit your pull request to one type of change. Submit multiple pull requests if needed. -->
 
-## Screenshots (if applicable)
+Please check the type of change your PR introduces:
 
-(prefer animated gif)
+- [ ] Bug-fix
+- [ ] Feature (functionality, design, translations, etc.)
+- [ ] Documentation change
+- [ ] Project management (tests, CI, GitHub configuration, etc.)
+- [ ] Other (please describe):
+
+## Current state
+
+<!-- Please describe the current behavior, content, or docs that you are modifying -- or link to relevant issue(s). -->
+
+Issue Number(s): 
+
+## Proposed changes
+
+<!-- Please describe the changes this PR makes. -->
+
+## Screenshots, if applicable
+
+<!-- For visual changes to the theme, this is required. -->
 
 ## Checklist
 
-_Ensure you have checked off the following before submitting your PR._
+<!-- Ensure you've completed the following items, as appropriate, before submitting your PR. -->
 
-- [ ] tested locally with the [latest release of Hugo](https://github.com/gohugoio/hugo/releases). This requirement is [a standard](https://github.com/gohugoio/hugoThemes#theme-maintenance)
-- [ ] added new dependencies
-- [ ] updated the [docs]() ⚠️
+- [ ] **Bug-fixes and new features:** I have tested locally with the [latest release of Hugo extended](https://github.com/gohugoio/hugo/releases). This requirement is [a standard](https://github.com/gohugoio/hugoThemes#theme-maintenance).
+- [ ] **Bug-fixes, new features, and doc changes:** I have updated the relevant documentation as part of this PR.