Skip to content

Instantly share code, notes, and snippets.

@j4w8n

j4w8n/pull-request-label-standard.md

Created December 13, 2024 20:14
Show Gist options
  • Save j4w8n/fd5d65651477d747eae053d1d8d90a9d to your computer and use it in GitHub Desktop.
Save j4w8n/fd5d65651477d747eae053d1d8d90a9d to your computer and use it in GitHub Desktop.
Download ZIP
Pull Request Label Standard
Raw
pull-request-label-standard.md

Pull Request Label Standard

In order to form a more perfect PR process, I'm proposing the use of standardized labels to mark a PR's status or statuses. It's main purpose is to benefit the community involved.

Your feedback is needed.

Notes

  • PRs are not required to be labeled at any point in their lifecycle; to remain suitable for appropriate triaging and handling.
  • PRs are not required to go through any or all "positive" steps on their way to being merged.
  • New PRs are not required to be given a default label.
  • No two labels should have the same color.
  • Label colors shall not be defined by this standard; however, an example color scheme is included for convenience.

Labels

  • considering - Being looked at and/or discussed; whether to accept or decline.
  • declined - Not planned. An explanation may be provided. (Is this needed, since one would simply close the PR with a comment?)
  • accepted - Plan to implement. This does not guarantee the PR's current code will be used, and could even be superceded by another PR. The PR may be approved and/or assigned at this point.
  • reviewing - A member or maintainer has started the process of reviewing the code.
  • testing - A member or maintainer has started the process of testing the code.
  • abandoned - Rejected for some reason, after being accepted. An explanation must be provided.
  • ready - Waiting to be merged. The PR must be approved by or at this point.
  • merged - Self-explanatory, and may not be needed.
  • reverted - PR was reverted. An explanation must be provided.

Thoughts

  • If a PR requires considering, then once it's declined or accepted it makes sense to remove the considering label. However, if a PR is accepted, that label might remain when subsequent labels, like reviewing or testing, are added; resulting in two or more labels on a PR at once.
  • waiting: author, if we're waiting on them to make changes, etc
  • waiting: upstream, if we're waiting for a fix from a package that we depend on

Example Color Scheme

  • abandoned (#716f6f)
  • accepted (#63e81d)
  • considering (#8dce94)
  • declined (#afafaf)
  • merged (#df1fe6)
  • ready (#ca90cc)
  • reverted (#141414)
  • reviewing (#6490d6)
  • testing (#1669ed)

image

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment