ookami-code-review
Installation
SKILL.md
Code Review Guide
Follow these guidelines when reviewing code or having your code reviewed. Full reference: https://github.com/ookamiinc/guides/blob/master/code_review.md
General Etiquette (Everyone)
- Accept that many programming decisions are opinions. Discuss tradeoffs, state your preference, and reach a resolution quickly.
- Ask questions instead of making demands. ("What do you think about naming this
:user_id?") - Ask for clarification when something is unclear. ("I didn't understand. Can you clarify?")
- Avoid selective ownership of code ("mine", "not mine", "yours").
- Avoid terms that refer to personal traits ("dumb", "stupid"). Assume everyone is attractive, intelligent, and well-meaning.
- Be explicit. People don't always understand intentions online.
- Be humble. ("I'm not sure - let's look it up.")
- Don't use hyperbole ("always", "never", "endlessly", "nothing").
- Don't use sarcasm.
- If too many "I didn't understand" or "Alternative solution:" comments arise, move to a synchronous conversation. Post a follow-up comment summarizing the offline discussion.