b5252fed65
Use Google style guide with refinements, because the Google style guide is a comprehensive, well-established style guide that is mostly based on PEP-8 and was accepted by everyone on the TUF team. There is no need to replicate these recommendations. However, we do provide a very slim document with additional refinements, in order to emphasize on items the we consider especially important, want to be handled differently, or in one specific way, where the Google guide would allow multiple. Signed-off-by: Lukas Puehringer <lukas.puehringer@nyu.edu> Co-authored-by: Joshua Lock <jlock@vmware.com>
1.7 KiB
Use Google Python style guide with minimal refinements
Technical Story: https://github.com/theupdateframework/tuf/issues/1128
Context and Problem Statement
The Secure Systems Lab code style guide, which has been used for most of the code base, has become outdated. Through the upcoming rewrite, we have the chance to ignore consistency considerations with existing code style and can choose a more standard and up-to-date style guide.
Decision Drivers
- Flaws in original Secure Systems Lab style guide
- Curating a complete custom style guide is time consuming
- Well-established style rules lower contribution barrier
- Custom style is not supported by default in common tooling (i.e. editors and linters)
Considered Options
- Use custom style guide
- Use Google style guide with refinements
Decision Outcome
Chosen option: "Use Google style guide with refinements", because the Google style guide is a comprehensive, well-established style guide that is mostly based on PEP-8 and was accepted by everyone on the TUF team. There is no need to replicate these recommendations. However, we do provide a very slim document with additional refinements, in order to emphasize items the we consider especially important, want to be handled differently, or in one specific way, where the Google guide would allow multiple.