Last active
February 15, 2024 18:01
-
-
Save smcabrera/bf7f11cd7684a8cfebdee5b760b0e299 to your computer and use it in GitHub Desktop.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Based on https://conventionalcomments.org/ | |
**issue (blocking, non-blocking or if-minor):** ❗ subject | |
Issues highlight specific problems with the subject under review. These problems can be user-facing or behind the scenes. It is strongly recommended to pair this comment with a suggestion. If you are not sure if a problem exists or not, consider leaving a question. | |
**nitpick**: 💅 subject | |
Nitpicks are trivial preference-based requests. These should be non-blocking by nature. | |
**praise**: 🙌 subject | |
Praises highlight something positive. Try to leave at least one of these comments per review. Do not leave false praise (which can actually be damaging). Do look for something to sincerely praise. | |
**question (non-blocking)**: ❓subject | |
Questions are appropriate if you have a potential concern but are not quite sure if it's relevant or not. Asking the author for clarification or investigation can lead to a quick resolution. | |
**suggestion (non-blocking, blocking or if-minor)**: 💡 subject | |
Suggestions propose improvements to the current subject. It's important to be explicit and clear on what is being suggested and why it is an improvement. | |
**todo**: ✔️ subject | |
TODO's are small, trivial, but necessary changes. Distinguishing todo comments from issues: or suggestions: helps direct the reader's attention to comments requiring more involvement. | |
**thought**: 💭 subject | |
Thoughts represent an idea that popped up from reviewing. These comments are non-blocking by nature, but they are extremely valuable and can lead to more focused initiatives and mentoring opportunities. | |
**chore**: 🧹 subject | |
Chores are simple tasks that must be done before the subject can be “officially” accepted. Usually, these comments reference some common process. Try to leave a link to the process description so that the reader knows how to resolve the chore. | |
**markdown table** | |
| Current | Updated | | |
| --------------- | --------------- | | |
| beep | boop | |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment