Skip to content

ppseprus/code-review-manifesto

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 

Repository files navigation

The Code Review Manifesto

  1. I do not write perfect code. Nobody does. This is rather obvious...
  2. I always want to improve myself. Everybody should. Nothing to explain here. Keep reading!
  3. I believe that Code Review is a useful tool to write quality code. It's a belief - Can't argue with that!
  4. I ask for Code Review to better myself as well as to improve the quality of the work I do.
  5. An issue is something that A) goes against the conventions, B) breaks the code, C) is simply missing or D) is dead wrong!
  6. A suggestion is something that is not an issue but could improve the code in some ways.
  7. I do not take comments personally. Not even a bit. Ever. It's work and I'm a professional!
  8. I do not write pejorative comments. Ever. Again, I'm a professional!
  9. I try to be constructive with my comments. The only way to go.
  10. I comment on each and every occurrence of an issue. This makes it easier for the developer to know all the lines that are needed to be edited.
  11. If I don't understand something, I ask about it. No shame in that!
  12. I always add a summary of the verbal discussions. It is a quick and efficient way to overcome issues, but others might have the same issue.
  13. I always reply to each and every comment, in a meaningful way. You never know who reads a thread and when, and who might learn from it now or then.
  14. When in doubt, write something fun! Having fun is a good way to avoid frustration...

This document is the result of the collaborative efforts of Miklós Antal (mkls), Adrián Sallai, Péter Seprűs (ppseprus) Kristóf Tombácz, Ábel Varga (rangeoshun) and Csaba Vályi (csabbee). Alphabetically.

Releases

No releases published

Packages

No packages published