Docs process tweaks: update PR template & CODEOWNERS #4591
Merged
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.
Changes
Add a line to the PR template, prompting to ping @withastro/maintainers-docs for docs feedback
Update
CODEOWNERS
to make @withastro/maintainers-docs “owners” of allREADME.md
files.What does this mean? File “owners” automatically receive a review request when a PR that touches their files come in. GitHub code owners docs →
Could be a bit too coarse-grained — could pick up
README.md
files in tests or whatever if we have them, so happy to refine that if it turns out to be annoying.Question
Do we want other files to auto-request a review from team docs?
The types file we use to generate our config reference springs to mind.<-- Added types file in 2af6766Testing
GitHub tooling tweaks only.
Docs
We’re here to help 🙌