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
python-tuf/docs/adr/index.md
Lukas Puehringer b5252fed65 ADR0005: Decide on python code style guide 
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>
2020-12-04 10:39:24 +01:00

1 KiB
Raw Permalink Blame History

Architectural Decision Log

This log lists the architectural decisions for tuf.

  • ADR-0000 - Use Markdown Architectural Decision Records
  • ADR-0001 - Default to Python 3.6 or newer for new development
  • ADR-0002 - Deprecation strategy
  • ADR-0003 - Develop TUF 1.0.0 in a subdirectory of the current TUF implementation
  • ADR-0004 - Add classes for complex metadata attributes
  • ADR-0005 - Use Google Python style guide with minimal refinements

For new ADRs, please use template.md as basis. More information on MADR is available at https://adr.github.io/madr/. General information about architectural decision records is available at https://adr.github.io/.