From d1187d44091edf8c5391e0327208103254c2de05 Mon Sep 17 00:00:00 2001 From: Dave Schaefer Date: Mon, 30 Dec 2019 21:09:38 -0700 Subject: [PATCH 1/3] README - add a flake8 project badge Add a project badge image and display on the README. This gives people a way to show they use Flake8 as the linter for their project, and link to the Flake8 project page. This may be a fun way for people to show their support, and help drive new users to Flake8. --- README.rst | 3 +++ docs/source/img/linter-flake8-green.svg | 1 + 2 files changed, 4 insertions(+) create mode 100644 docs/source/img/linter-flake8-green.svg diff --git a/README.rst b/README.rst index a182b9b..5383558 100644 --- a/README.rst +++ b/README.rst @@ -2,6 +2,9 @@ Flake8 ======== +.. image:: docs/source/img/linter-flake8-green.svg + :target: https://gitlab.com/pycqa/flake8 + Flake8 is a wrapper around these tools: - PyFlakes diff --git a/docs/source/img/linter-flake8-green.svg b/docs/source/img/linter-flake8-green.svg new file mode 100644 index 0000000..482462c --- /dev/null +++ b/docs/source/img/linter-flake8-green.svg @@ -0,0 +1 @@ + linterlinterflake8flake8 \ No newline at end of file From bdcf2f8c271d926f7801e8156207030ea8c92568 Mon Sep 17 00:00:00 2001 From: Dave Schaefer Date: Mon, 30 Dec 2019 21:13:02 -0700 Subject: [PATCH 2/3] docs - add badge instructions to quickstart guide Show user how to add the Flake8 badge to their project. These local URLs would need to be replaced with a hosted https version once the image is actually hosted somewhere. --- docs/source/index.rst | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/docs/source/index.rst b/docs/source/index.rst index 9488985..6f5e8a5 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -69,6 +69,23 @@ Alternatively, if you want to *ignore* only one specific warning or error: Please read our user guide for more information about how to use and configure |Flake8|. +Flake8 Project Badge +-------------------- +If you'd like to add a |Flake8| badge to your project to show off your use of +|Flake8|, add the following to your README.rst: + +:: + + .. image:: docs/source/img/linter-flake8-green.svg + :target: https://gitlab.com/pycqa/flake8 + +or README.md: + +:: + + [![linter: flake8](docs/source/img/linter-flake8-green.svg)](https://gitlab.com/pycqa/flake8) + + FAQ and Glossary ================ From c5075b5580a2325e0825f49496af188bc7eac8cd Mon Sep 17 00:00:00 2001 From: Dave Schaefer Date: Mon, 30 Dec 2019 21:31:47 -0700 Subject: [PATCH 3/3] docs - run end-of-file fixer on svg file did not have pre-commit hooks installed after cloning. this fixes the file --- docs/source/img/linter-flake8-green.svg | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/img/linter-flake8-green.svg b/docs/source/img/linter-flake8-green.svg index 482462c..dfd70b9 100644 --- a/docs/source/img/linter-flake8-green.svg +++ b/docs/source/img/linter-flake8-green.svg @@ -1 +1 @@ - linterlinterflake8flake8 \ No newline at end of file + linterlinterflake8flake8