Skip to content

Instantly share code, notes, and snippets.

<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8" />
<link rel="stylesheet" type="text/css" href="dep/normalize.css/normalize.css" />
<link rel="stylesheet" type="text/css" href="dep/Font-Awesome/css/font-awesome.css" />
<link rel="stylesheet" type="text/css" href="style.css" />
<style id="jsbin-css">
@page{
size: letter portrait;
@maddy531
maddy531 / comments.md
Last active March 27, 2023 13:48 — forked from millerized/comments.md
Mark pull request comments with a purpose

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