Merge pull request #366 from chipzoller/proj-mgmt-typos

Fixing typos, broken links, clarifying steps in new docs

7 files changed, 51 insertions, 31 deletions

diff --git a/.github/ISSUE_TEMPLATE/01-bug_report.yml b/.github/ISSUE_TEMPLATE/01-bug_report.yml
index 4437ce3..252f108 100644
--- a/.github/ISSUE_TEMPLATE/01-bug_report.yml
+++ b/.github/ISSUE_TEMPLATE/01-bug_report.yml
@@ -1,5 +1,5 @@
 name: Bug report
-description: Something isn't working correctly with the theme
+description: Something isn't working correctly with the theme.
 title: "[Bug] "
 labels: ["bug"]
 body:
@@ -18,9 +18,9 @@ body:
     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."
+        - 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) to build my site."
           required: true
-        - label: "I have read the [theme documentation](https://github.com/chipzoller/hugo-clarity/blob/master/README.md)."
+        - label: "I have read the [Hugo Clarity 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
@@ -40,13 +40,16 @@ body:
       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."
+        - "Other: Both, neither, or somewhere else."
     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.
+      description:
+        For example, iOS 14, Windows 10, macOS 12.5, Linux Ubuntu 22.04, Android
+        12, etc.
     validations:
       required: true
   - type: input
@@ -82,7 +85,8 @@ body:
     attributes:
       label: Relevant log output
       description:
-        If applicable, provide any errors, stacktraces or other output from Hugo.
+        If applicable, provide any errors, stacktraces or other output from
+        Hugo.
       render: shell
   - type: textarea
     id: related_code
@@ -103,7 +107,10 @@ body:
     id: other_info
     attributes:
       label: Other information
-      description: Any other information that might be relevant to this bug.
+      description:
+        Any other information that might be relevant to this bug. Do you know on
+        what date or git commit this bug might have appeared? If so, please let
+        us know!
   - type: markdown
     attributes:
       value: |
diff --git a/.github/ISSUE_TEMPLATE/02-feature_request.yml b/.github/ISSUE_TEMPLATE/02-feature_request.yml
index 0ef1fc4..2a8b508 100644
--- a/.github/ISSUE_TEMPLATE/02-feature_request.yml
+++ b/.github/ISSUE_TEMPLATE/02-feature_request.yml
@@ -1,5 +1,5 @@
 name: Feature request
-description: Suggest a new feature for the theme
+description: Suggest a new feature for the theme.
 title: "[Feature] "
 labels: ["enhancement"]
 body:
@@ -8,7 +8,7 @@ body:
     attributes:
       label: "I confirm:"
       options:
-        - label: "I have read the [theme documentation](https://github.com/chipzoller/hugo-clarity/blob/master/README.md)."
+        - label: "I have read the [Hugo Clarity 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
@@ -53,12 +53,10 @@ body:
     id: context
     attributes:
       label: Additional Context
-      description: Any additional context for this feature request.
-      placeholder: 
+      description:
         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.
+        why it would be a useful addition, use cases or problem statements, etc.
     validations:
       required: false
   - type: markdown
diff --git a/.github/ISSUE_TEMPLATE/03-docs_update.yml b/.github/ISSUE_TEMPLATE/03-docs_update.yml
index b65eb65..32b67e8 100644
--- a/.github/ISSUE_TEMPLATE/03-docs_update.yml
+++ b/.github/ISSUE_TEMPLATE/03-docs_update.yml
@@ -1,5 +1,5 @@
 name: Documentation change
-description: Suggest a change to theme documentation
+description: Suggest a change to theme documentation.
 title: "[Docs] "
 labels: ["documentation"]
 body:
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
index e7db5a4..f731a2d 100644
--- a/.github/ISSUE_TEMPLATE/config.yml
+++ b/.github/ISSUE_TEMPLATE/config.yml
@@ -1,5 +1,12 @@
 blank_issues_enabled: false
 contact_links:
+  - name: Ask questions and get support
+    url: https://github.com/chipzoller/hugo-clarity/discussions
+    about:
+      If you have a question, want general support that isn't about a bug in the
+      theme, or want to discuss new ideas without making a specific feature
+      request, please use GitHub Discussions. This keeps our issue queue focused
+      on actionable items. Thanks!
   - name: Read Hugo Clarity documentation
     url: https://github.com/chipzoller/hugo-clarity/blob/master/README.md
     about:
@@ -7,4 +14,4 @@ contact_links:
       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
+    about: Help us make this theme great!
diff --git a/.github/pull-request_template.md b/.github/pull-request_template.md
index 6c42d36..889799c 100644
--- a/.github/pull-request_template.md
+++ b/.github/pull-request_template.md
@@ -1,4 +1,5 @@
-<!--- Please provide a general summary of your changes in the title above -->
+
+<!--- Please provide a general summary of your changes in the title above. If GitHub has inserted "Signed-off-by," above, you can remove it if you like. -->
 
 ## Pull Request type
 
@@ -32,3 +33,4 @@ Issue Number(s):
 
 - [ ] **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.
+- [ ] **All PRs:** I have [signed off](https://github.com/chipzoller/hugo-clarity/blob/master/CONTRIBUTING.md#how-to-submit-a-pull-request) (using `git commit -s ...`), or if not possible due to developer environment constraints, will comment below confirming that I am adhering to the [Developer Certificate of Origin](https://probot.github.io/apps/dco/).
diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
index 99e53c7..85c227a 100644
--- a/CODE_OF_CONDUCT.md
+++ b/CODE_OF_CONDUCT.md
@@ -71,7 +71,7 @@ members of the project's leadership.
 ## Attribution
 
 This Code of Conduct is adapted from the 
-[Contributor Covenant][https://www.contributor-covenant.org/], version 1.4,
+[Contributor Covenant](https://www.contributor-covenant.org/), version 1.4,
 available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
 
 For answers to common questions about this code of conduct, see
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index a98f0f2..024c984 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -9,8 +9,8 @@ to learn, inspire, and create. Any contributions you make will benefit others,
 and are **greatly appreciated**!
 
 When contributing, especially for the first time, consider starting by
-[creating an issue](https://github.com/chipzoller/hugo-clarity/issues/new) so
-you can get feedback from the maintainers and avoid unncessary work.
+[creating an issue](https://github.com/chipzoller/hugo-clarity/issues/new/choose)
+so you can get feedback from the maintainers and avoid unncessary work.
 
 **Note:** Hugo Clarity has a [code of conduct](CODE_OF_CONDUCT.md).
 Please follow it in all your interactions with the project.
@@ -27,13 +27,14 @@ rather than posting an issue.
 
 You've found a bug in the source code, a mistake in the documentation or maybe
 you'd like a new feature? You can help us by
-[submitting an issue](https://github.com/chipzoller/hugo-clarity/issues).
-Before you create an issue, make sure to search the issue archive -- your issue
-may have already been addressed!
+[submitting an issue](https://github.com/chipzoller/hugo-clarity/issues/new/choose).
+Before you create an issue, make sure to
+[search the current issues](https://github.com/chipzoller/hugo-clarity/issues)
+-- your issue may have already been addressed!
 
 Once a bug has been confirmed or a feature has been approved, you are welcome
-to [submit a Pull Request](#submit-a-pull-request) -- if you have the solution,
-please do tell us about it!
+to [submit a Pull Request](#how-to-submit-a-pull-request) -- if you have the
+solution, please do tell us about it!
 
 ### Helping us fix bugs
 
@@ -52,9 +53,9 @@ order to help us help you, create bug reports that are:
 ## How to submit a Pull Request
 
 1. Search our repository for open or closed
-   [Pull Requests](https://github.com/chipzoller/hugo-clarity/pulls) that
-   relate to your issue. You don't want to duplicate effort, and if one already
-   exists you can collaborate on that.
+   [Pull Requests](https://github.com/chipzoller/hugo-clarity/pulls?q=is%3Apr+sort%3Aupdated-desc)
+   that relate to your issue. You don't want to duplicate effort, and if one
+   already exists you can collaborate on that.
 
 2. Ensure that you plan to work consistent with the
    [Developer Certificate of Origin](https://developercertificate.org/). This
@@ -64,8 +65,11 @@ order to help us help you, create bug reports that are:
    in order to contribute to Hugo Clarity**, and you'll need to confirm your
    consent when committing, as shown below.
 
-3. Clone the project using [Gitpod](https://github.com/chipzoller/hugo-clarity#option-1a-development-in-the-browser)
-   or [locally on your machine](https://github.com/chipzoller/hugo-clarity#option-1b-development-on-your-machine)
+3. [Fork the project](https://docs.github.com/en/get-started/quickstart/fork-a-repo),
+   then checkout your fork using
+   [Gitpod](https://github.com/chipzoller/hugo-clarity/blob/master/README.md#getting-up-and-running)
+   or
+   [locally on your machine](https://github.com/chipzoller/hugo-clarity/blob/master/README.md#option-1b-development-on-your-machine)
 
 4. Create a new branch:
 
@@ -91,7 +95,7 @@ order to help us help you, create bug reports that are:
 7. Repeat steps 5-6 as necessary.
 
 8. Unless your PR is documentation-only, **test your work 
-   [using Hugo extended](https://github.com/chipzoller/hugo-clarity#prerequisites)
+   [using Hugo extended](https://github.com/chipzoller/hugo-clarity/blob/master/README.md#prerequisites)
    to build a site.** When you submit your PR we'll run test-builds of a Hugo
    site with your PR applied, so you'll save time if you fix any build issues
    before submitting.
@@ -103,7 +107,9 @@ order to help us help you, create bug reports that are:
    ```
 
 10. [Open a Pull Request](https://github.com/chipzoller/hugo-clarity/compare?expand=1)
-   and wait for feedback. Filling out the PR as requested will ensure your work
-   gets reviewed by maintainers promptly.
+   by
+   "[comparing across forks](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork)"
+   and filling out the form. Completing the PR template as requested will ensure
+   your work gets reviewed by maintainers promptly.
 
 ## 🎉 **Thank you for your contribution!**