Skip to content

Commit 41259a4

Browse files
docs: add pr template for docs team (#3581)
1 parent a0f4ccb commit 41259a4

File tree

3 files changed

+53
-31
lines changed

3 files changed

+53
-31
lines changed
Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
**Description of changes**
2+
3+
4+
5+
**Required**
6+
7+
- [ ] Used LinkOut component on external links
8+
- [ ] Reviewed Vale errors and made changes where appropriate
9+
- [ ] Ran Prettier
10+
- [ ] Previewed updates in Netlify
11+
- [ ] Received SME and/or peer approval if updates are significant
12+
- [ ] Included a "fixes #" comment
13+
14+
**Conditional**
15+
16+
- [ ] Ensured sequence diagrams follow our style guide
17+
- [ ] Included code samples where appropriate
18+
- [ ] Updated related READMEs
Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
<!--- Pull request titles should follow conventional commit format. -->
2+
3+
<!--
4+
Thanks for opening a PR! Your contribution is much appreciated.
5+
In order to make sure your PR is handled as smoothly as possible we request that you follow the checklist sections below.
6+
Choose the right checklist for the change that you're making:
7+
-->
8+
9+
## Changes proposed in this pull request
10+
<!--
11+
Provide a succinct description of what this pull request entails.
12+
-->
13+
-
14+
15+
## Context
16+
<!--
17+
What were you trying to do?
18+
Provide further details about how the feature should be tested/reviewed if necessary.
19+
Link issues here - using `fixes #number`
20+
-->
21+
22+
## Checklist
23+
<!--
24+
Checklist items become clickable check boxes once the pull request is created. There is no need to edit them now.
25+
-->
26+
27+
- [ ] Related issues linked using `fixes #number`
28+
- [ ] Tests added/updated
29+
- [ ] Make sure that all checks pass
30+
- [ ] Bruno collection updated (if necessary)
31+
- [ ] Documentation issue created with `user-docs` label (if necessary)
32+
- [ ] OpenAPI specs updated (if necessary)

.github/pull_request_template.md

Lines changed: 3 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,4 @@
1-
<!--- Pull request titles should follow conventional commit format. -->
1+
Please go to the `Preview` tab and select the appropriate sub-template:
22

3-
<!--
4-
Thanks for opening a PR! Your contribution is much appreciated.
5-
In order to make sure your PR is handled as smoothly as possible we request that you follow the checklist sections below.
6-
Choose the right checklist for the change that you're making:
7-
-->
8-
9-
## Changes proposed in this pull request
10-
<!--
11-
Provide a succinct description of what this pull request entails.
12-
-->
13-
-
14-
15-
## Context
16-
<!--
17-
What were you trying to do?
18-
Provide further details about how the feature should be tested/reviewed if necessary.
19-
Link issues here - using `fixes #number`
20-
-->
21-
22-
## Checklist
23-
<!--
24-
Checklist items become clickable check boxes once the pull request is created. There is no need to edit them now.
25-
-->
26-
27-
- [ ] Related issues linked using `fixes #number`
28-
- [ ] Tests added/updated
29-
- [ ] Make sure that all checks pass
30-
- [ ] Bruno collection updated (if necessary)
31-
- [ ] Documentation issue created with `user-docs` label (if necessary)
32-
- [ ] OpenAPI specs updated (if necessary)
3+
* [Engineering](?expand=1&template=eng_template.md)
4+
* [Documentation](?expand=1&template=doc_template.md)

0 commit comments

Comments
 (0)