Skip to content

Commit

Permalink
Cleanup the README
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
ericwb committed Feb 14, 2022
1 parent dbefd04 commit b8ff685
Showing 1 changed file with 12 additions and 26 deletions.
38 changes: 12 additions & 26 deletions README.rst
Expand Up @@ -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
---------------

Expand All @@ -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

0 comments on commit b8ff685

Please sign in to comment.