Repository navigation
Conversation
| - ready_for_review | ||
| - converted_to_draft | ||
| schedule: | ||
| - cron: "0 18 * * *" # 1 PM EST |
There was a problem hiding this comment.
This was an arbitrary time, we can change this to whenever makes sense to the team.
|
|
||
| env: | ||
| LABEL: needs-template | ||
| GRACE_DAYS: "3" |
There was a problem hiding this comment.
I figured 3 days was ample time for a user to reply as well as allocates time for the weekend.
| permissions: {} | ||
|
|
||
| env: | ||
| LABEL: needs-template |
There was a problem hiding this comment.
I've already added this label.
763f94f to
10d1662
Compare
|
Not blocking, but I wonder if we could compare the contents of EDIT: It looks like this is the approach the electron repo uses. |
I was considering this at first, but the issue is that the second half of the template is optional. |
Yeah that does make it more difficult - we'd need a way to annotate sections as optional either in the template or as parameters in the action and then it's just getting too complicated. I'd say regex is probably fine for now, since we can always come back if we ever update the template and forget to update the action. |
|
Do we want to have a step that removes the label if the check is satisfied? or do we want that to be a manual step that one of us takes |
Hmm, good question. My initial thought was that one of us should remove it, but i'm open to updating this pattern. |
|
since the type is edited, we can check for edited description. I think it's reasonable to have it self remove if it gets fixed |
verythorough
left a comment
There was a problem hiding this comment.
Thanks for doing this! I made a non-blocking suggestion in the doc.
I also wonder if we should adjust the opening statement to say that we're happy to receive contributions that solve actual user problems.
| 1. Once you have marked your PR as `Ready for Review` please do not force push to the branch | ||
| 2. Fill out the [pull request template](./.github/PULL_REQUEST_TEMPLATE.md). PRs that are ready for review but do not follow the template are labeled `needs-template` and closed automatically after 3 days. |
There was a problem hiding this comment.
I suggest reversing the order of these two.
Change summary
This PR adds a workflow that enforces PR templates for contributors outside of the
fastlyorg.The workflow does the following:
fastlyorg is opened, edited, reopened or marked ready for review, it checks that the description includes a non-empty### Change summaryand theAll Submissions:checklist.needs-templatelabel and posts a single comment listing what to fix. When the description is fixed, the label and comment are removed.OWNER/MEMBER), bots and draft PRs are never checked. Converting a PR to draft clears the label, and the 3 days start again when it's marked ready for review.Other notable Repos use similar workflows:
Both of these examples close non-compliant PRs immediately, while this proposed workflow provides a 3 day grace period.
Why
We have seen an increase in PRs that skip the template or include little context, which makes them slow to review. This check gives contributors early, consistent feedback on what we need, and closes PRs that don't provide it, so maintainers spend less time on back-and-forth.
All Submissions: