Skip to content
Snippets Groups Projects

Extend code review docs with chapter about the right balance

Merged Grzegorz Bizon requested to merge doc/extend-code-review-guidelines into master
All threads resolved!
@@ -87,12 +87,12 @@ reviewee.
@@ -87,12 +87,12 @@ reviewee.
design is important as well. Building abstractions and good design is what
design is important as well. Building abstractions and good design is what
makes it possible to hide complexity and is a leverage for the future work.
makes it possible to hide complexity and is a leverage for the future work.
- Asking reviewee to change the design sometimes means the complete rewrite of
- Asking reviewee to change the design sometimes means the complete rewrite of
the contributed code. It is usually a good idea to ask an other merge request
the contributed code. It is usually a good idea to ask other merge request
endboss before doing it, but have a courage to do it when you believe it is
endboss before doing it, but have the courage to do it when you believe it is
important.
important.
- There is a difference in doing things right and doing things right now.
- There is a difference in doing things right and doing things right now.
Ideally we should do the former but in real world we need the latter as well.
Ideally, we should do the former, but in the real world we need the latter as
The good example is a security fix which should be released as soon as
well. The good example is a security fix which should be released as soon as
possible. Asking reviewee to do the major refactoring in the merge request
possible. Asking reviewee to do the major refactoring in the merge request
that is an urgent fix should be avoided.
that is an urgent fix should be avoided.
- Doing things well today is usually better than doing something perfectly
- Doing things well today is usually better than doing something perfectly
Loading