.github/PULL_REQUEST_TEMPLATE.md: add checklist
Add a checklist to help PR submitters and reviewers understand what extra docs
are required when making user-facing changes.
@@ -4,9 +4,9 @@ Welcome to the Operator SDK! Before contributing, make sure to:
- Read the contributing guidelines https://github.com/operator-framework/operator-sdk/blob/master/CONTRIBUTING.MD
- Rebase your branch on the latest upstream master
-- Add a changelog file by copying changelog/fragments/00-template.yaml
- Link any relevant issues, PR's, or documentation
- When fixing an issue, add "Closes #<ISSUE_NUMBER>"
+- Follow the below checklist if making a user-facing change
-->
@@ -14,3 +14,10 @@ Welcome to the Operator SDK! Before contributing, make sure to:
**Motivation for the change:**
+
+
+**Checklist**
+
+If the pull request includes user-facing changes, extra documentation is required:
+- [ ] Add a new changelog fragment in `changelog/fragments` (see [`changelog/fragments/00-template.yaml`](https://github.com/operator-framework/operator-sdk/tree/master/changelog/fragments/00-template.yaml))
+- [ ] Add or update relevant sections of the docs website in [`website/content/en/docs`](https://github.com/operator-framework/operator-sdk/tree/master/website/content/en/docs)
