Define a pr template to encourage thorough pr descriptions

CodelyTV / pr-size-labeler

🏷 Visualize and optionally limit the size of your Pull Requests

https://github.com/marketplace/actions/pull-request-size-labeler

MIT License

336 stars 58 forks source link

Define a pr template to encourage thorough pr descriptions #73

Closed johnlk closed 5 months ago

johnlk commented 5 months ago

Example for this change:

What type of PR is this? (check all applicable)

[ ] Refactor
[ ] Feature
[ ] Bug Fix
[ ] Optimization
[x] Documentation Update

Description

I've add 5 sections to the PR template, let me know if we need more:

type of PR
description
notes to the reviewer
how to test
links to issues addressed

Notes to Reviewer

Let me know if there's other ideas or sections we should consider adding.

How to test

N/A

Link to issues addressed

N/A

johnlk commented 5 months ago

LGTM.

The only non-blocking suggestion would be to move the template to the .github/ directory in order to keep the root directory as clean as possible unifying all the GitHub related stuff in its own folder.

Good call. For some reason, I thought this had to be in the root dir, but I guess not: https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/creating-a-pull-request-template-for-your-repository

Fixing