Skip to content
This repository has been archived by the owner on Aug 16, 2023. It is now read-only.

[MIRROR] Use draft pull requests instead of the 'Work In Progress' and 'Needs Review' labels. #581

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

AeonSS13
Copy link

Original PR: tgstation/tgstation#56168

Why

Draft PRs are a system maintained by Github that we've basically duplicated with the Work in Progress/Needs Review labels and auto-tagger. Any maintainer can convert a PR to a draft and vice-versa.
image

It makes a lot more sense to lose these labels and use the draft system. Here's a few reasons why:

  • Clearer Picture of PRs Needing Review: Currently, when a maintainer leaves a review on a PR it gets a Changes Requested status. This helps maintainers to see what PRs need review at a glance. The problem with that is when the contributor addresses the review, it sticks around. I attempted to get around this limitation in the past by crafting an auto-review dismissal system if all review comments were resolved, but this had it's own setbacks. Instead, I propose maintainers, after reviewing a PR, set it to be a draft and contributors can change it back to ready once they've addressed issues.
  • Contributor Control: Contributors can only control their labels through the auto-tagger via title changes ([WIP] and [READY] in this case). This is already a heavy-handed method (and makes PR titles ugly as sin) and is completely unnecessary with the draft system where it's just a click of a button.
  • Good as PR: Draft PRs are seen the same as regular PRs by the API. So all our tooling like the auto-tagger and stalebot (despite my attempts to make that otherwise) will work as normal.
  • Less crusty code: The PHP bot is a mess and I want it gone ASAP. The less we use it the better. Eventually we'll fully replace it with actions.

TL;DR: If a PR is green, it's either ready to merge and needs to be looked at by a maintainer, waiting for 24h, or should be test merged. Otherwise, should be grey.

Upon this being merged, delete the two labels.

Side note: This PR also fixes a bug in the auto commenting system that's supposed to remind people to write changelogs which I'm pretty sure we don't use anyway.

@ tgstation/commit-access

Cyberboss and others added 2 commits January 16, 2021 00:08
…Review' labels. (#56168)

Conflicts:
	tools/WebhookProcessor/github_webhook_processor.php
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants