Skip to content

Commit f12c828

Browse files
Merge pull request #445 from mulesoft/w-10592636-writers-checklist
[w-10592636] add .github/pull_request_template.md
2 parents 23c3d82 + 33836c0 commit f12c828

1 file changed

Lines changed: 22 additions & 0 deletions

File tree

.github/pull_request_template.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# Writer's Quality Checklist
2+
3+
Before merging your PR, did you:
4+
5+
- [ ] Run spell checker
6+
- [ ] Run link checker to check for broken xrefs
7+
- [ ] Check for orphan files
8+
- [ ] Perform a local build and do a final visual check of your content, including checking for:
9+
- Broken images
10+
- Dead links
11+
- Correct rendering of partials if they are used in your content
12+
- Formatting issues, such as:
13+
- Misnumbered ordered lists (steps) or incorrectly nested unordered lists
14+
- Messed up tables
15+
- Proper indentation
16+
- Correct header levels
17+
- [ ] Receive final review and signoff from:
18+
- Technical SME
19+
- Product Manager
20+
- Editor or peer reviewer
21+
- Reporter, if this content is in response to a reported issue (internal or external feedback)
22+
- [ ] If applicable, verify that the software actually got released

0 commit comments

Comments
 (0)