Skip to content

Fixing typo's in the pySCG main readme #793

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Feb 25, 2025
Merged

Fixing typo's in the pySCG main readme #793

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6f55df5
Fixing typo's in the pySCG main readme
myteron Feb 13, 2025
0fd6790
providing better explaination for ant-pattern
myteron Feb 13, 2025
3320825
providing better explaination for ant-pattern
myteron Feb 13, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions docs/Secure-Coding-Guide-for-Python/readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Anti pattern could be a foreign concept to beginners. I would suggest changing this to:

noncompliantXX.py: anti-pattern (bad programming practice).

As this describes to the user what exactly is within the file, and also will teach them what the term anti-pattern means, without having to go to google straight away.

* `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:
Expand Down