Skip to content

Commit 6c332ea

Browse files
martyavsunilarjunbtat
authored
#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 <[email protected]> * Update .github/pull_request_template.md Co-authored-by: Billy Tat <[email protected]> * 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 <[email protected]> Co-authored-by: Billy Tat <[email protected]>
1 parent ef5ab63 commit 6c332ea

File tree

3 files changed

+51
-7
lines changed

3 files changed

+51
-7
lines changed

.github/ISSUE_TEMPLATE/request-a-new-feature.md

+14-4
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,23 @@ about: For requesting new feature(s) to be added to the docs.
44
title: ''
55
labels: ''
66
assignees: ''
7-
87
---
98

10-
**Summary:**
9+
## Related Issues
10+
11+
<!--
12+
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.
13+
-->
14+
15+
## Summary
16+
17+
<!--
1118
Describe the new feature. If QA has not yet tested the new feature/process, please also file a ticket with QA for their review.
19+
-->
1220

21+
## Details
1322

14-
**Details:**
23+
<!--
1524
- Include all pertinent information, e.g., screenshots, resource requirements, workarounds, links, etc.
16-
- List page link(s) in the current docs where the new feature applies, if applicable.
25+
- List page link(s) in the current docs where the new feature applies, if applicable.
26+
-->

.github/ISSUE_TEMPLATE/request-an-update.md

+10-3
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,15 @@ about: For fixing docs errors/typos, adding needed/missing information, updating
44
title: ''
55
labels: ''
66
assignees: ''
7-
87
---
98

10-
**Summary:**
11-
Describe the requested update giving as much detail as possible. Please also list page link(s) in the current docs where the update applies.
9+
## Related Issues
10+
<!--
11+
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.
12+
-->
13+
14+
## Summary
15+
16+
<!--
17+
Describe the requested update giving as much detail as possible. Please also list page link(s) in the current docs where the update applies.
18+
-->

.github/pull_request_template.md

+27
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
<!--
2+
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.
3+
-->
4+
5+
Fixes #[issue_number]
6+
7+
## Reminders
8+
9+
- See the [README](../README.md) for more details on how to work with the Rancher docs.
10+
11+
- 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.
12+
13+
- If the pull request is dependent on an upcoming release, make sure to target the release branch instead of `main`.
14+
15+
## Description
16+
17+
<!--
18+
- What is the goal of this pull request?
19+
- What did you change?
20+
- Are there any other pull requests, tickets, or issues associated with this pull request?
21+
-->
22+
23+
## Comments
24+
25+
<!--
26+
Any additional notes a reviewer should know before we review.
27+
-->

0 commit comments

Comments
 (0)