http://wiki.opensfs.org/index.php?action=history&feed=atom&title=Lustre_Code_Reviews 2026-11-15T13:31:16Z Revision history for this page on the wiki MediaWiki 1.43.3 http://wiki.opensfs.org/index.php?title=Lustre_Code_Reviews&diff=1167&oldid=prev 2014-11-01T00:39:04Z

<p></p> <table style="background-color: #fff; color: #202122;" data-mw="interface"> <col class="diff-marker" /> <col class="diff-content" /> <col class="diff-marker" /> <col class="diff-content" /> <tr class="diff-title" lang="en"> <td colspan="2" style="background-color: #fff; color: #202122; text-align: center;">← Older revision</td> <td colspan="2" style="background-color: #fff; color: #202122; text-align: center;">Revision as of 16:39, 31 October 2014</td> </tr><tr><td colspan="2" class="diff-lineno" id="mw-diff-left-l3">Line 3:</td> <td colspan="2" class="diff-lineno">Line 3:</td></tr> <tr><td class="diff-marker"></td><td style="background-color: #f8f9fa; color: #202122; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><div>Code reviews are not just about making pretty code and running a spell checker.  Software quality can be divided into two areas: Source Code Quality and Product Quality.  Source Code Quality aims to make the source more readable and presumably maintainable.  Product Quality strives to make the running binary meet expectations, be stable, and be fault resistant.  Code reviews need to enforce quality expectations in both areas.</div></td><td class="diff-marker"></td><td style="background-color: #f8f9fa; color: #202122; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><div>Code reviews are not just about making pretty code and running a spell checker.  Software quality can be divided into two areas: Source Code Quality and Product Quality.  Source Code Quality aims to make the source more readable and presumably maintainable.  Product Quality strives to make the running binary meet expectations, be stable, and be fault resistant.  Code reviews need to enforce quality expectations in both areas.</div></td></tr> <tr><td class="diff-marker"></td><td style="background-color: #f8f9fa; color: #202122; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><br></td><td class="diff-marker"></td><td style="background-color: #f8f9fa; color: #202122; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><br></td></tr> <tr><td class="diff-marker" data-marker="−"></td><td style="color: #202122; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #ffe49c; vertical-align: top; white-space: pre-wrap;"><div><del style="font-weight: bold; text-decoration: none;">Some expectations that </del>we <del style="font-weight: bold; text-decoration: none;">have of persons performing </del>Lustre code <del style="font-weight: bold; text-decoration: none;">reviews include</del>:</div></td><td class="diff-marker" data-marker="+"></td><td style="color: #202122; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #a3d3ff; vertical-align: top; white-space: pre-wrap;"><div><ins style="font-weight: bold; text-decoration: none;">The following is an incomplete list of things </ins>we <ins style="font-weight: bold; text-decoration: none;">expect </ins>Lustre code <ins style="font-weight: bold; text-decoration: none;">reviewers to enforce</ins>:</div></td></tr> <tr><td class="diff-marker"></td><td style="background-color: #f8f9fa; color: #202122; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><br></td><td class="diff-marker"></td><td style="background-color: #f8f9fa; color: #202122; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><br></td></tr> <tr><td class="diff-marker" data-marker="−"></td><td style="color: #202122; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #ffe49c; vertical-align: top; white-space: pre-wrap;"><div>* <del style="font-weight: bold; text-decoration: none;">Thing 1</del></div></td><td class="diff-marker" data-marker="+"></td><td style="color: #202122; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #a3d3ff; vertical-align: top; white-space: pre-wrap;"><div>* <ins style="font-weight: bold; text-decoration: none;">Code changes are correctly implemented and function correctly</ins></div></td></tr> <tr><td class="diff-marker" data-marker="−"></td><td style="color: #202122; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #ffe49c; vertical-align: top; white-space: pre-wrap;"><div>* <del style="font-weight: bold; text-decoration: none;">Thing 2</del></div></td><td class="diff-marker" data-marker="+"></td><td style="color: #202122; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #a3d3ff; vertical-align: top; white-space: pre-wrap;"><div>*<ins style="font-weight: bold; text-decoration: none;">* Reviewer is expected to understand how the code works, and the implications of the change</ins></div></td></tr> <tr><td colspan="2" class="diff-side-deleted"></td><td class="diff-marker" data-marker="+"></td><td style="color: #202122; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #a3d3ff; vertical-align: top; white-space: pre-wrap;"><div><ins style="font-weight: bold; text-decoration: none;">* Command line tools are not only functional, but also well designed</ins></div></td></tr> <tr><td colspan="2" class="diff-side-deleted"></td><td class="diff-marker" data-marker="+"></td><td style="color: #202122; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #a3d3ff; vertical-align: top; white-space: pre-wrap;"><div><ins style="font-weight: bold; text-decoration: none;">* Git commit message describes what the change does, and why</ins></div></td></tr> <tr><td colspan="2" class="diff-side-deleted"></td><td class="diff-marker" data-marker="+"></td><td style="color: #202122; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #a3d3ff; vertical-align: top; white-space: pre-wrap;"><div><ins style="font-weight: bold; text-decoration: none;">* Functions, structures, and files are adequately documented</ins></div></td></tr> <!-- diff cache key wiki_opensfs_org-wiki_:diff:1.41:old-1166:rev-1167:php=table --> </table>

Morrone http://wiki.opensfs.org/index.php?title=Lustre_Code_Reviews&diff=1166&oldid=prev 2014-11-01T00:21:54Z

<p>Created page with &quot;One of the most important tools for maintaining software code quality is the peer review process. When you review potential Lustre code changes on the [http://review.whamclou...&quot;</p> <p><b>New page</b></p><div>One of the most important tools for maintaining software code quality is the peer review process. When you review potential Lustre code changes on the [http://review.whamcloud.com|code review system], you are taking part in an essential part of the software development process.<br /> <br /> Code reviews are not just about making pretty code and running a spell checker. Software quality can be divided into two areas: Source Code Quality and Product Quality. Source Code Quality aims to make the source more readable and presumably maintainable. Product Quality strives to make the running binary meet expectations, be stable, and be fault resistant. Code reviews need to enforce quality expectations in both areas.<br /> <br /> Some expectations that we have of persons performing Lustre code reviews include:<br /> <br /> * Thing 1<br /> * Thing 2</div>

Morrone