docs: add checklist to PR template #5524
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds a checklist section to the pull request template to ensure documentation updates are considered when user-facing features are modified.
Key Changes:
- Added a checklist section with prompts for documentation updates
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| **Checklist** | ||
|
|
||
| [ ] Does this PR change user facing features? | ||
| [ ] Has documentation been updated? |
There was a problem hiding this comment.
Checkbox syntax is incorrect. GitHub markdown requires a space between the brackets for checkboxes. Use - [ ] instead of [ ] to create proper interactive checkboxes in the PR template.
Suggested change
| [ ] Has documentation been updated? | |
| - [ ] Has documentation been updated? |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation
Our docs frequently lag behind the code.
Description
Add a simple reminder to devs that changes in user facing features
require updating the documentation as well.