From 2cf68ac927b0e2a2aedc8c5460d75151393e501d Mon Sep 17 00:00:00 2001 From: Dorian Turba <froggit.commit.z3jqj@simplelogin.com> Date: Mon, 28 Aug 2023 17:07:09 +0200 Subject: [PATCH] fix quote links for badges --- templates/python/code_quality/black/README.md | 8 +++----- templates/python/code_quality/flake8/README.md | 6 ++---- templates/python/code_quality/isort/README.md | 6 ++---- templates/python/code_quality/mypy/README.md | 2 +- templates/python/code_quality/ruff/README.md | 12 ++++++++---- templates/python/testing/pytest/README.md | 4 +--- 6 files changed, 17 insertions(+), 21 deletions(-) diff --git a/templates/python/code_quality/black/README.md b/templates/python/code_quality/black/README.md index 7e6c0ef..b35a176 100644 --- a/templates/python/code_quality/black/README.md +++ b/templates/python/code_quality/black/README.md @@ -19,12 +19,10 @@ pre-commit, etc), you can use `pyproject.toml` configuration file. Learn more about [pyproject](https://pip.pypa.io/en/stable/reference/build-system/pyproject-toml/) configuration files. -## Add a [](https://github.com/psf/black) badge to your project README.md +## Add a [](https://github.com/psf/black) badge to your project README.md To display the use of Black in your project, you can add the following badge to your README.md: ```markdown -<a href="https://github.com/psf/black"> - <img alt="Code style: black" src="https://img.shields.io/badge/code%20style-black-000000.svg"> -</a> -``` \ No newline at end of file +[](https://github.com/psf/black) +``` diff --git a/templates/python/code_quality/flake8/README.md b/templates/python/code_quality/flake8/README.md index 854e76d..835eb06 100644 --- a/templates/python/code_quality/flake8/README.md +++ b/templates/python/code_quality/flake8/README.md @@ -17,12 +17,10 @@ To add configuration to `flake8` shared with any other usage of flake8 (such as pre-commit, etc), you can use `.flake8` configuration file. Learn more about [flake8 configuration](https://flake8.pycqa.org/en/latest/user/configuration.html) files. -## Add a [](https://flake8.pycqa.org/) badge to your project README.md +## Add a [](https://flake8.pycqa.org/) badge to your project README.md To display the use of Flake8 in your project, you can add the following badge to your README.md: ```markdown -<a href="https://flake8.pycqa.org/"> - <img alt="Code style: Flake8" src="https://img.shields.io/badge/Flake8-checks-blue"> -</a> +[](https://flake8.pycqa.org/) ``` diff --git a/templates/python/code_quality/isort/README.md b/templates/python/code_quality/isort/README.md index 61467a0..e3275d7 100644 --- a/templates/python/code_quality/isort/README.md +++ b/templates/python/code_quality/isort/README.md @@ -19,12 +19,10 @@ pre-commit, etc), you can use `pyproject.toml` configuration file or a dedicated more about [isort configuration](https://pycqa.github.io/isort/docs/configuration/config_files.html) files. -## Add an [](https://pycqa.github.io/isort/) badge to your project README.md +## Add a [](https://pycqa.github.io/isort/) badge to your project README.md To display the use of isort in your project, you can add the following badge to your README.md: ```markdown -<a href="https://pycqa.github.io/isort/"> - <img alt="Imports: isort" src="https://img.shields.io/badge/Imports-isort-yellow"> -</a> +[](https://pycqa.github.io/isort/) ``` diff --git a/templates/python/code_quality/mypy/README.md b/templates/python/code_quality/mypy/README.md index c8c7793..d776265 100644 --- a/templates/python/code_quality/mypy/README.md +++ b/templates/python/code_quality/mypy/README.md @@ -18,7 +18,7 @@ To add configuration to `mypy` shared with any other usage of mypy (such as manu etc), you can use `mypy.ini`, `setup.cfg` or `pyproject.toml` configuration file. Learn more about [mypy configuration](https://mypy.readthedocs.io/en/stable/config_file.html) files. -## Add a [](https://mypy.readthedocs.io/) badge to your project README.md +## Add a [](https://mypy.readthedocs.io/) badge to your project README.md To display the use of mypy in your project, you can add the following badge to your README.md: diff --git a/templates/python/code_quality/ruff/README.md b/templates/python/code_quality/ruff/README.md index 6a9dc91..558d6b7 100644 --- a/templates/python/code_quality/ruff/README.md +++ b/templates/python/code_quality/ruff/README.md @@ -19,12 +19,16 @@ pre-commit, etc), you can use a `pyproject.toml`, `ruff.toml`, or `.ruff.toml` c your project's root directory. Learn more about [ruff configuration](https://beta.ruff.rs/docs/configuration/) files. -## Add a [](https://github.com/astral-sh/ruff) badge to your project README.md +## Add a [](https://github.com/astral-sh/ruff) badge to your project README.md To display the use of Ruff in your project, you can add the following badge to your README.md: ```markdown -<a href="https://github.com/ruffle-rs/ruffle"> - <img alt="Code style: Ruff" src="https://img.shields.io/badge/Ruff-Linter-blue"> -</a> +[](https://github.com/astral-sh/ruff) +``` + +A more "classic" version of the badge ([](https://github.com/astral-sh/ruff)) is also available: + +```markdown +[](https://github.com/astral-sh/ruff) ``` diff --git a/templates/python/testing/pytest/README.md b/templates/python/testing/pytest/README.md index 7a8607d..9adbf09 100644 --- a/templates/python/testing/pytest/README.md +++ b/templates/python/testing/pytest/README.md @@ -54,7 +54,5 @@ https://docs.r2devops.io/get-started/use-templates/#multiple-usage-of-the-same-j To display the use of pytest in your project, you can add the following badge to your README.md: ```markdown -<a href="https://docs.pytest.org/en/latest/"> - <img alt="Tested with pytest" src="https://img.shields.io/badge/Tested%20with-pytest-green"> -</a> +[](https://docs.pytest.org/en/latest/) ``` -- GitLab