Skip to content

5. Style Guide

Ali Heydari edited this page Oct 5, 2023 · 2 revisions

Style Guides Required for Code Review

In general, well-written and consistent code is acceptable for review; however, to normalize the process and make the reviewing easier (as well as documentation), we request all codes to follow Google's guidelines, which are widely accepted in academia and in the industry. Links to the aforementioned guidelines for Python and C++ can be found below:

  • Python: Accepted style guide for Python can be found here. Note that any deviations from the style guide will result in a failed CR (which means more work for you and the reviewer).

  • C++: Our group's accepted style guide for C++ can be found here.