Open tordans opened 1 month ago
:bento: You can preview the tagging presets of this pull request here.
I like this idea as it helps us newbies to provide all necessary informations.
Maybe we could add a hint in the "Related issues"-Section to use the closes #Issue-Number
Syntax because sometimes issues stay open after the related PR was merged (Example 1, Example 2) and afaik by using closes #...
these Issues are closed automatic after a successful PR.
Note to self: New users don't get the preview (and checks) automatically. Once a PR was merged, the checks run for that user automatically.
This is a test comment to test the copy-paste template
i
name
, aliases
(if present) use Title Caseterms
(if present) use lower case, sorted A-Z
@tyrasd this is ready to be merged from my point of view. It will make new PRs a lot easier to review… I will iterate on it if needed once we learn how people use / understand it.
We can use a pull request template to nudge contributors to add information to the PRs that make it easier to review them.
This template is based on https://github.com/twbs/bootstrap/blob/main/.github/PULL_REQUEST_TEMPLATE.md?plain=1 but change to fit the tagging schema.
My idea is, to nudge contributors to first add more context to PRs like links. But then after the preview was generated, to get back , edit the description and add more links and screenshots that make it super fast to review the PRs.
Here are the docs on adding those templates. In general they are much less fancy than the issue templates, so it's just a Markdown template. https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/creating-a-pull-request-template-for-your-repository