public/rancher-docs
1
0
Fork 0
mirror of https://github.com/rancher/rancher-docs.git synced 2026-05-16 01:53:51 +00:00
Code Issues Packages Projects Releases Wiki Activity

#795 Update issue templates, add PR template (#833)

Browse Source 
* 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>
This commit is contained in:
Marty Hernandez Avedon
2023-09-13 16:38:01 -04:00
committed by GitHub
parent ef5ab63ddd
commit 6c332ea0e6
3 changed files with 51 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.github/ISSUE_TEMPLATE/request-a-new-feature.md
+14 -4
View File
@@ -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.
- List page link(s) in the current docs where the new feature applies, if applicable.
-->
.github/ISSUE_TEMPLATE/request-an-update.md
+10 -3
View File
@@ -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.
## 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.
-->
.github/pull_request_template.md
+27
View File
@@ -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.
-->