Skip to content

Latest commit

 

History

History
24 lines (18 loc) · 1.95 KB

style.md

File metadata and controls

24 lines (18 loc) · 1.95 KB

Programming Style

Style is very important. The goals of a project's style typically revolve around making it simple, readable, and clean. See this post For some thoughts on how to make your code more readable, see the Composite Style Guide.

Please document in your repository (e.g. in the README.md) which coding style you're using. If you'd like to understand the motivation behind a specific style, please see the Composite Style Guide.

It is important, when you're working on a team to use a consistent style. It is more important to choose one and stick with it, than to choose the "perfect style". You can find many different styles online, including

  • Google's C++ style, Java style, and Python style
  • Linux's C style
  • GWU's OS research group's C style along with justifications

Though not relevant for this class, many modern languages have prescribed styles such as go, and Rust.

Style requirements for this class. For the purposes of this class, never bring code to the instructional staff or to peer review sessions that isn't properly indented. That is the minimum bar that humans need to be able to understand code. If you bring code that isn't indented, then we will think that you haven't put a sincere effort into understanding your code as you haven't invested care into making it understandable.