diff options
author | Kurian Benoy <70306694+kurianbenoy-aot@users.noreply.github.com> | 2022-02-21 13:40:18 +0530 |
---|---|---|
committer | GitHub <noreply@github.com> | 2022-02-21 09:10:18 +0100 |
commit | 47a947cdcae21a8803719cd38fc014b7e5978f58 (patch) | |
tree | c4e2119a9028268543702f3f4f14057127fe03da | |
parent | ea8645e19b6e020854c0bfac584dbd48a2da04dd (diff) | |
download | pylint-git-47a947cdcae21a8803719cd38fc014b7e5978f58.tar.gz |
Add note on how to share the badge for pylint (#5820)
Co-authored-by: Daniël van Noord <13665637+DanielNoord@users.noreply.github.com>
Co-authored-by: Jacob Walls <jacobtylerwalls@gmail.com>
Co-authored-by: Pierre Sassoulas <pierre.sassoulas@gmail.com>
-rw-r--r-- | CONTRIBUTORS.txt | 2 | ||||
-rw-r--r-- | README.rst | 21 |
2 files changed, 23 insertions, 0 deletions
diff --git a/CONTRIBUTORS.txt b/CONTRIBUTORS.txt index 8bfe42a47..66480ea6a 100644 --- a/CONTRIBUTORS.txt +++ b/CONTRIBUTORS.txt @@ -216,6 +216,8 @@ contributors: * Kosarchuk Sergey: contributor +* Kurian Benoy: contributor + * Carey Metcalfe: demoted `try-except-raise` from error to warning * Marcus Näslund (naslundx): contributor diff --git a/README.rst b/README.rst index 32871e01c..fb2411447 100644 --- a/README.rst +++ b/README.rst @@ -149,7 +149,28 @@ Do not forget to clone astroid_ and install the last version:: cd astroid python3 -m pip install -e . +Show your usage +----------------- +You can place this badge in your README to let others know your project uses pylint. + + .. image:: https://img.shields.io/badge/linting-pylint-yellowgreen + :target: https://github.com/PyCQA/pylint + +Use the badge in your project's README.md (or any other Markdown file):: + + [![linting: pylint](https://img.shields.io/badge/linting-pylint-yellowgreen)](https://github.com/PyCQA/pylint) + +Use the badge in your project's README.rst (or any other rst file):: + + .. image:: https://img.shields.io/badge/linting-pylint-yellowgreen + :target: https://github.com/PyCQA/pylint + + +If you use GitHub Actions, and one of your CI workflows begins with "name: pylint", you +can use GitHub's +[workflow status badges](https://docs.github.com/en/actions/monitoring-and-troubleshooting-workflows/adding-a-workflow-status-badge#using-the-workflow-file-name) +to show an up-to-date indication of whether pushes to your default branch pass pylint. For more detailed information, check the documentation. .. _here: https://pylint.pycqa.org/en/latest/user_guide/installation.html |