Skip to content

Commit b2d9d5b

Browse files
authored
Update pull_request_template.md
1 parent fd0cbab commit b2d9d5b

1 file changed

Lines changed: 18 additions & 20 deletions

File tree

.github/pull_request_template.md

Lines changed: 18 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,20 @@
1-
# Writer's Quality Checklist
1+
### Description
22

3-
Before merging your PR, did you:
3+
** Explain briefly the changes introduced in this PR **
44

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
5+
### Checklist:
6+
7+
* The content:
8+
* Contains no technical inaccuracies.
9+
* Uses correct grammar.
10+
* Has no formatting errors.
11+
* Conforms to the MuleSoft CX Writing Style Reference.
12+
* Conforms to the A11Y guidelines in Writing for Accessibility.
13+
* For RN pages with What’s New: includes the correct date in the :page-revdate: attribute (to add to Latest Releases).
14+
* Product names and other terminology conform to the Term Presentation Reference.
15+
* Screenshots follow the guidance in the Desktop Screenshot Quick Reference for MuleSoft Docs.
16+
17+
### Pull Request guidelines
18+
19+
Before creating a Pull Request please make sure it complies with our developing standards stated in our development guide:
20+
https://github.com/mulesoft/api-designer-2/blob/develop/docs/DevelopmentGuide.md#pull-request

0 commit comments

Comments
 (0)