Skip to content

Instantly share code, notes, and snippets.

@eleciawhite
Created March 25, 2022 19:38
Show Gist options
  • Save eleciawhite/2dce6219d830ebc124dae152b61c8901 to your computer and use it in GitHub Desktop.
Save eleciawhite/2dce6219d830ebc124dae152b61c8901 to your computer and use it in GitHub Desktop.
Giving feedback on code and designs can be difficult. Note that the developer has invested much time and effort in the development so it can be difficult to hear about issues. Often it is better to ask about the issue as a question than as a direct comment (i.e. “Where are the returned error codes checked by the calling code?” is easier than “This function is broken.”). With each comment, please note the severity of the item found:
• BUG: This is wrong. If you opt not to change it, I’d like to understand why.
• OUGHTTO: This is going to be a problem and ought to be fixed but if there is a good reason to leave it for now, ok but add a comment or something.
• MAYBE: If there is time and you agree this should be changed. There may be a better way.
• NIT: My OCD compels me to point this out but it need not compel you to make any changes.
• KUDOS: This area is particularly good.
Note: all but the first of these levels are advisory; the developer is permitted to use the feedback as they see fit.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment