From 6f55df5d66b3280a79c28ec5a5e72ac1e98f9f72 Mon Sep 17 00:00:00 2001 From: Helge Wehder Date: Thu, 13 Feb 2025 10:24:14 +0000 Subject: [PATCH 1/3] Fixing typo's in the pySCG main readme Signed-off-by: Helge Wehder --- docs/Secure-Coding-Guide-for-Python/readme.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/Secure-Coding-Guide-for-Python/readme.md b/docs/Secure-Coding-Guide-for-Python/readme.md index d34eb638..d6d4723b 100644 --- a/docs/Secure-Coding-Guide-for-Python/readme.md +++ b/docs/Secure-Coding-Guide-for-Python/readme.md @@ -23,12 +23,12 @@ Every person writing code shall study the following: ## Secure Coding Standard for Python -Code examples are written to explain security design with as little code as possible. __None__ of the code examples are intendet to be used 'as is' for production. Using the code is at your own risk! +Code examples are written to explain security design with as little code as possible. __None__ of the code examples are intended to be used 'as is' for production. Using the code is at your own risk! -__Code file naminng conventions:__ +__Code file naming conventions:__ * `noncompliantXX.py` anti-pattern. -* `compliantXX.py` mitigation for mitigating or removal of __ONLY__ the described risk. +* `compliantXX.py` mitigation or removal of __ONLY__ the described risk. * `exampleXX.py` to allow understanding the documented behaviour. It is __not production code__ and requires code-style or python best practices to be added such as: From 0fd6790b3a652476ed9026a8d336a5cc6c2c13ed Mon Sep 17 00:00:00 2001 From: Helge Wehder Date: Thu, 13 Feb 2025 11:32:06 +0000 Subject: [PATCH 2/3] providing better explaination for ant-pattern --- docs/Secure-Coding-Guide-for-Python/readme.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/Secure-Coding-Guide-for-Python/readme.md b/docs/Secure-Coding-Guide-for-Python/readme.md index d6d4723b..04919c46 100644 --- a/docs/Secure-Coding-Guide-for-Python/readme.md +++ b/docs/Secure-Coding-Guide-for-Python/readme.md @@ -27,7 +27,7 @@ Code examples are written to explain security design with as little code as poss __Code file naming conventions:__ -* `noncompliantXX.py` anti-pattern. +* `noncompliantXX.py` anti-pattern, bad programming practice. * `compliantXX.py` mitigation or removal of __ONLY__ the described risk. * `exampleXX.py` to allow understanding the documented behaviour. From 33208259ea97b3b09828ef390b3a16a6359aeb32 Mon Sep 17 00:00:00 2001 From: Helge Wehder Date: Thu, 13 Feb 2025 11:33:00 +0000 Subject: [PATCH 3/3] providing better explaination for ant-pattern Signed-off-by: Helge Wehder --- docs/Secure-Coding-Guide-for-Python/readme.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/Secure-Coding-Guide-for-Python/readme.md b/docs/Secure-Coding-Guide-for-Python/readme.md index 04919c46..0906054b 100644 --- a/docs/Secure-Coding-Guide-for-Python/readme.md +++ b/docs/Secure-Coding-Guide-for-Python/readme.md @@ -27,7 +27,7 @@ Code examples are written to explain security design with as little code as poss __Code file naming conventions:__ -* `noncompliantXX.py` anti-pattern, bad programming practice. +* `noncompliantXX.py` anti-pattern, bad programming practice. * `compliantXX.py` mitigation or removal of __ONLY__ the described risk. * `exampleXX.py` to allow understanding the documented behaviour.