Skip to content

[w-10592636] add .github/pull_request_template.md#161

Open
cheungaryk wants to merge 3 commits intov1.2from
w-10592636-writers-checklist
Open

[w-10592636] add .github/pull_request_template.md#161
cheungaryk wants to merge 3 commits intov1.2from
w-10592636-writers-checklist

Conversation

@cheungaryk
Copy link
Copy Markdown
Contributor

ref: W-10592636

Enhancements

add the following PR template. If merged, future pull requests to the latest branch will be pre-populated with the following content:


Writer's Quality Checklist

Before merging your PR, did you:

  • Run spell checker
  • Run link checker to check for broken xrefs
  • Check for orphan files
  • Perform a local build and do a final visual check of your content, including checking for:
    • Broken images
    • Dead links
    • Correct rendering of partials if they are used in your content
    • Formatting issues, such as:
      • Misnumbered ordered lists (steps) or incorrectly nested unordered lists
      • Messed up tables
      • Proper indentation
      • Correct header levels
  • Receive final review and signoff from:
    • Technical SME
    • Product Manager
    • Editor or peer reviewer
    • Reporter, if this content is in response to a reported issue (internal or external feedback)
  • If applicable, verify that the software actually got released

@cheungaryk cheungaryk requested review from a team and priyaayyar as code owners May 4, 2022 22:26
@cheungaryk
Copy link
Copy Markdown
Contributor Author

also...shouldn't the default branch of this repo be v1.2 instead of v1.0? Do you need help to change that? (I don't have permission to change it, but can ask around)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant