CommunityToolkit
CommunityToolkit copied to clipboard
Create a PR template
This is potentially going to be a challenge given we house documentation for multiple different toolkits.
Just for reference here is the current template from the Xamarin Community Toolkit:
## Fixes # <!-- Link to a relevant issue # in this docs repository (if any, otherwise remove this line) -->
## Docs for Toolkit PR [#](https://github.com/xamarin/XamarinCommunityToolkit/pull/#) <!-- Link to relevant issue or Feature PR # of the Xamarin community toolkit repo which will create a reference to the associated issue and PR once it is created, remove if not tied to an issue or feature -->
## What changes to the docs does this PR provide?
<!-- Please describe the updated information in detail -->
## PR Checklist
Please check if your PR fulfills the following requirements:
- [ ] For new pages, used the [provided template](https://github.com/MicrosoftDocs/xamarin-communitytoolkit/blob/master/docs/.template.md).
- [ ] For new features, added an entry in the [Table of Contents](https://github.com/MicrosoftDocs/xamarin-communitytoolkit/blob/master/docs/TOC.yml).
- [ ] Ran against a spell and grammar checker.
- [ ] Contains **NO** breaking changes.
<!-- If this PR contains a breaking change, please describe the impact and migration path for existing applications below. -->
## Other information
As far as I understand it is possible to have multiple PR templates however you do not get a friendly selector like you do with Issue templates. Therefore my questions are:
- Do we need to find a common format?
- Can we disable the shortcut to create a PR and instead provide links to specific templates?
- Any better options?
cc @brminnick @davidbritch @michael-hawker
Ideally we should have a similar/common template for how we write our docs to align with how the rest of the docs are written for the other platforms (as they're generally consistent).
I'm hoping eventually we'll have a way to keep docs in our main repo and push them here automatically, so that may make some of this easier. (It has been a struggle to have a separate repo for docs when reviewing/coordinating PRs on the main repos.) We're going to be testing that out with our new Toolkit Labs for Windows project.
We still need to centralize/unify the wiki across the repos, so we can also link out to a wiki landing page which could have more details if needed.
We could also look at adding the FabricBot here and in the PR template do some detection of a checkbox for which project it relates to and then have the bot post more guidance afterwards or something.
I like the sound of both:
I'm hoping eventually we'll have a way to keep docs in our main repo and push them here automatically, so that may make some of this easier.
This sounds like it could simplify the workflow of approving/providing changes.
and
We could also look at adding the FabricBot here and in the PR template do some detection of a checkbox for which project it relates to and then have the bot post more guidance afterwards or something.
This may work in the short term to provide some more specific information for now like linking back to the repository for the toolkit the docs change applies to.