Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs process tweaks: update PR template & CODEOWNERS #4591

Merged
merged 5 commits into from
Sep 2, 2022
Merged

Conversation

delucis
Copy link
Member

@delucis delucis commented Sep 1, 2022

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 all README.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 2af6766

Testing

GitHub tooling tweaks only.

Docs

We’re here to help 🙌

@changeset-bot
Copy link

changeset-bot bot commented Sep 1, 2022

⚠️ No Changeset found

Latest commit: 7ff1fd8

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@sarah11918
Copy link
Member

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.

Funnily enough, this pull request .md file is the kind of thing Docs could be pinged on, since it involves text? 😂 The types file for configuration reference does make sense, too.

@delucis
Copy link
Member Author

delucis commented Sep 1, 2022

Funnily enough, this pull request .md file is the kind of thing Docs could be pinged on

Could also make this even looser and say team docs are code owners for *.md. Almost certain to pull in excessive stuff though. I don’t think we need a hard fix for all Astro text.

We could NWTWWHB on this for now and then do a detailed audit where you list all things you’d like to be auto-pinged on and I figure out how to configure that.

Also worth noting that not being code owner doesn’t mean you can’t be pinged manually. I think it’s probably better to be slightly too narrow in scope than too wide for automated notifications as otherwise we’ll likely end up ignoring the review requests as “oh yeah that automated thing that is normally irrelevant”.

@sarah11918
Copy link
Member

@delucis Yup, I think README's are a perfectly good place to start! I was just more amused than anything. Don't think we need a wider scope right now! But the types file, yes.

Copy link
Contributor

@matthewp matthewp left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

Co-Authored-By: Dan Jutan <[email protected]>
Co-Authored-By: Sarah Rainsberger <[email protected]>
Co-Authored-By: Fred K. Schott <[email protected]>
@delucis delucis merged commit b48c18e into main Sep 2, 2022
@delucis delucis deleted the chris/team-docs branch September 2, 2022 16:39
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.

None yet

6 participants