Skip to content

Commit e5279db

Browse files
germa89PipKat
andauthored
Adding security considerations (#38)
* Adding security considerations * Apply suggestions from code review Co-authored-by: Kathy Pippert <[email protected]> Co-authored-by: Kathy Pippert <[email protected]>
1 parent 0cb1c0f commit e5279db

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

doc/source/coding_style/best_practices.rst

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -709,3 +709,16 @@ letter is a consonant.
709709

710710
The second approach is more readable and better documented. Additionally,
711711
you could implement a unit test for ``is_consonant``.
712+
713+
714+
Security Considerations
715+
~~~~~~~~~~~~~~~~~~~~~~~
716+
717+
Security, an ongoing process involving people and practices, ensures application confidentiality, integrity, and availability [#]_.
718+
Any library should be secure and implement good practices that avoid or mitigate possible security risks.
719+
This is especially relevant in libraries that request user input (such as web services).
720+
Because security is a broad topic, we recommend you review this useful Python-specific resource:
721+
722+
* `10 Unknown Security Pitfalls for Python <https://blog.sonarsource.com/10-unknown-security-pitfalls-for-python>`_ - By Dennis Brinkrolf - Sonar source blog
723+
724+
.. [#] Wikipedia - `Software development security <https://en.wikipedia.org/wiki/Software_development_security>`_.

0 commit comments

Comments
 (0)