From b8ff685ae805f8fbf677befdc18f585fdfc198c5 Mon Sep 17 00:00:00 2001 From: Eric Brown Date: Mon, 14 Feb 2022 05:09:33 -0800 Subject: [PATCH] Cleanup the README There's duplicate information in the README regarding where to contribute, where to open bugs, where the documentation lies. This change deletes the dups and also puts the references at the end which is standard for most documents. --- README.rst | 38 ++++++++++++-------------------------- 1 file changed, 12 insertions(+), 26 deletions(-) diff --git a/README.rst b/README.rst index bbffffa60..c4cc80d31 100644 --- a/README.rst +++ b/README.rst @@ -46,32 +46,6 @@ it generates a report. Bandit was originally developed within the OpenStack Security Project and later rehomed to PyCQA. -References ----------- - -Bandit docs: https://bandit.readthedocs.io/en/latest/ - -Python AST module documentation: https://docs.python.org/3/library/ast.html - -Green Tree Snakes - the missing Python AST docs: -https://greentreesnakes.readthedocs.org/en/latest/ - -Documentation of the various types of AST nodes that Bandit currently covers -or could be extended to cover: -https://greentreesnakes.readthedocs.org/en/latest/nodes.html - -Contributing ------------- - -Follow our Contributing file: -https://github.com/PyCQA/bandit/blob/main/CONTRIBUTING.md - -Reporting Bugs --------------- - -Bugs should be reported on github. To file a bug against Bandit, visit: -https://github.com/PyCQA/bandit/issues - Show Your Style --------------- @@ -90,3 +64,15 @@ using RST:: .. image:: https://img.shields.io/badge/security-bandit-yellow.svg :target: https://github.com/PyCQA/bandit :alt: Security Status + +References +---------- + +Python AST module documentation: https://docs.python.org/3/library/ast.html + +Green Tree Snakes - the missing Python AST docs: +https://greentreesnakes.readthedocs.org/en/latest/ + +Documentation of the various types of AST nodes that Bandit currently covers +or could be extended to cover: +https://greentreesnakes.readthedocs.org/en/latest/nodes.html