Elgato_dark/python-tuf
1
0
Fork 0
mirror of https://github.com/theupdateframework/python-tuf synced 2026-05-24 10:08:28 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

ADR0005: Decide on python code style guide

Browse source 
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>
This commit is contained in:
Lukas Puehringer 2020-12-03 18:15:09 +01:00
parent d3cd0cd0cd
commit b5252fed65
2 changed files with 41 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

40
docs/adr/0005-use-google-python-style-guide.md Normal file
View file

@ -0,0 +1,40 @@
# 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.
## Links
* [New Slim Secure Systems Lab style guide](https://github.com/secure-systems-lab/code-style-guidelines/pull/21)
* [Google Python style guide](https://google.github.io/styleguide/pyguide.html)
* [PEP 8](https://www.python.org/dev/peps/pep-0008/)
* [Issues in original Secure Systems Lab style guide](https://github.com/secure-systems-lab/code-style-guidelines/issues/20)

1
docs/adr/index.md
View file

@ -9,6 +9,7 @@ This log lists the architectural decisions for tuf.
- [ADR-0002](0002-pre-1-0-deprecation-strategy.md) - Deprecation strategy
- [ADR-0003](0003-where-to-develop-TUF-1-0-0.md) - Develop TUF 1.0.0 in a subdirectory of the current TUF implementation
- [ADR-0004](0004-extent-of-OOP-in-metadata-model.md) - Add classes for complex metadata attributes
- [ADR-0005](0005-use-google-python-style-guide.md) - Use Google Python style guide with minimal refinements
<!-- adrlogstop -->