From 6c332ea0e621c452c0149e02e06d5a8e6db7b4e5 Mon Sep 17 00:00:00 2001
From: Marty Hernandez Avedon <marty.avedon@suse.com>
Date: Wed, 13 Sep 2023 16:38:01 -0400
Subject: [PATCH] #795 Update issue templates, add PR template (#833)

* added PR template, made all templates consistent with format seen in Release Notes repo template

* Apply suggestions from code review

Co-authored-by: Sunil Singh <sunil.singh@suse.com>

* Update .github/pull_request_template.md

Co-authored-by: Billy Tat <btat@suse.com>

* Update request-an-update.md - spacing + connected > related

* Update request-a-new-feature.md - consistent wording

* updated PR template with link to readme, removed comment tags from reminder section as readme link wouldn't be clickable otherwise

---------

Co-authored-by: Sunil Singh <sunil.singh@suse.com>
Co-authored-by: Billy Tat <btat@suse.com>
---
 .../ISSUE_TEMPLATE/request-a-new-feature.md   | 18 ++++++++++---
 .github/ISSUE_TEMPLATE/request-an-update.md   | 13 ++++++---
 .github/pull_request_template.md              | 27 +++++++++++++++++++
 3 files changed, 51 insertions(+), 7 deletions(-)
 create mode 100644 .github/pull_request_template.md

diff --git a/.github/ISSUE_TEMPLATE/request-a-new-feature.md b/.github/ISSUE_TEMPLATE/request-a-new-feature.md
index 23385bdcf31b..902c8387d0f8 100644
--- a/.github/ISSUE_TEMPLATE/request-a-new-feature.md
+++ b/.github/ISSUE_TEMPLATE/request-a-new-feature.md
@@ -4,13 +4,23 @@ about: For requesting new feature(s) to be added to the docs.
 title: ''
 labels: ''
 assignees: ''
-
 ---
 
-**Summary:**
+## Related Issues
+
+<!--
+List any issues or tickets on other platforms that are associated with the request. For example, include a link to the issue tracking that feature in the Rancher repo, or list the Jira ticket number for the request. 
+-->
+
+## Summary
+
+<!--
 Describe the new feature. If QA has not yet tested the new feature/process, please also file a ticket with QA for their review.
+-->
 
+## Details
 
-**Details:**
+<!--
 - Include all pertinent information, e.g., screenshots, resource requirements, workarounds, links, etc.
-- List page link(s) in the current docs where the new feature applies, if applicable.
\ No newline at end of file
+- List page link(s) in the current docs where the new feature applies, if applicable.
+-->
diff --git a/.github/ISSUE_TEMPLATE/request-an-update.md b/.github/ISSUE_TEMPLATE/request-an-update.md
index 1a36aedfe533..7a9b24fd7e58 100644
--- a/.github/ISSUE_TEMPLATE/request-an-update.md
+++ b/.github/ISSUE_TEMPLATE/request-an-update.md
@@ -4,8 +4,15 @@ about: For fixing docs errors/typos, adding needed/missing information, updating
 title: ''
 labels: ''
 assignees: ''
-
 ---
 
-**Summary:**
-Describe the requested update giving as much detail as possible. Please also list page link(s) in the current docs where the update applies.
\ No newline at end of file
+## Related Issues
+<!--
+List any issues or tickets on other platforms that are associated with the request. For example, include a link to the issue tracking that feature in the Rancher repo, or list the Jira ticket number for the request.
+-->
+
+## Summary
+
+<!--
+Describe the requested update giving as much detail as possible. Please also list page link(s) in the current docs where the update applies.
+-->
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
new file mode 100644
index 000000000000..0f835da48dd5
--- /dev/null
+++ b/.github/pull_request_template.md
@@ -0,0 +1,27 @@
+<!--
+Check the Rancher docs issues to see if there is an existing issue for this pull request. If there is, enter the issue number below.
+-->
+
+Fixes #[issue_number]
+
+## Reminders
+
+- See the [README](../README.md) for more details on how to work with the Rancher docs.
+
+- Verify if changes pertain to other versions of Rancher. If they do, finalize the edits on one version of the page, then apply the edits to the other versions.
+
+- If the pull request is dependent on an upcoming release, make sure to target the release branch instead of `main`.
+
+## Description
+
+<!--
+- What is the goal of this pull request? 
+- What did you change? 
+- Are there any other pull requests, tickets, or issues associated with this pull request?
+-->
+
+## Comments
+
+<!--
+Any additional notes a reviewer should know before we review.
+-->
\ No newline at end of file