Skip to content

Instantly share code, notes, and snippets.

@maddy531

maddy531/comments.md

Forked from millerized/comments.md
Last active March 27, 2023 13:48
Show Gist options
  • Save maddy531/bfe6582eddf7fbe6bd842d76f1c936a6 to your computer and use it in GitHub Desktop.
Save maddy531/bfe6582eddf7fbe6bd842d76f1c936a6 to your computer and use it in GitHub Desktop.
Download ZIP
Mark pull request comments with a purpose
Raw
comments.md

This is a set of ‘statuses’ that pull request comments must be marked with to help explain intent.

  • Praise: Highlighting positive practice/action
  • Nitpick: Trivial non-blocking preference-based requests
  • Suggested Change: Propose improvements to the current subject
  • Issue: Highlights specific problems with the subject under review
  • Todo: Are small, trivial, but necessary changes
  • Question: Questions are appropriate if you have a potential concern but are not quite sure if it's relevant or not
  • Required: This must be fixed before merge
  • Thought: Represent an idea that popped up from reviewing
  • Chore: Simple tasks that must be done before the subject can be “officially” accepted

// Not from conventional comments

  • Nice to have: this should be fixed eventually, non-blocking
  • Personal Preference: I would do this, but you don’t have to

Modified from Conventional Comments

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