From 2385ebe7b044dcfcc0dc2fff43d303de712b4412 Mon Sep 17 00:00:00 2001 From: Lukas Puehringer Date: Fri, 4 Dec 2020 10:49:45 +0100 Subject: [PATCH] Add style guide usage instructions to ADR0005 Similar instructions are in the style guide preamble, but we repeat it here for emphasis. Signed-off-by: Lukas Puehringer --- docs/adr/0005-use-google-python-style-guide.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/adr/0005-use-google-python-style-guide.md b/docs/adr/0005-use-google-python-style-guide.md index bc618a89..8dfa278a 100644 --- a/docs/adr/0005-use-google-python-style-guide.md +++ b/docs/adr/0005-use-google-python-style-guide.md @@ -32,6 +32,12 @@ 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. +**Course of Action:** +* Follow existing style when working on existing code (files) +* Follow new style in any new code (files) +* Consider providing linter and formatter configuration (e.g. pylint, flake8, + black, yapf) to enforce and facilitate new style + ## Links * [New Slim Secure Systems Lab style guide](https://github.com/secure-systems-lab/code-style-guidelines/pull/21)