From 75bc105605604f54ec5c3abfdce53fbe51158c3d Mon Sep 17 00:00:00 2001 From: Newbyte Date: Wed, 21 May 2025 22:52:10 +0200 Subject: [PATCH] CONTRIBUTING.md, README.md: Use descriptive links Markdownlint complained about the links not being descriptive enough for accesibility purposes, so make them actually describe what we're linking to. Alternative to https://gitlab.postmarketos.org/postmarketOS/pmbootstrap/-/merge_requests/2602 Part-of: https://gitlab.postmarketos.org/postmarketOS/pmbootstrap/-/merge_requests/2605 [ci:skip-build]: already built successfully in CI --- CONTRIBUTING.md | 4 ++-- README.md | 3 +-- 2 files changed, 3 insertions(+), 4 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7f272a08..63e78388 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -20,8 +20,8 @@ A lot of the coding style is enforced by the CI scripts. code). * Use [f-strings](https://peps.python.org/pep-0498/) for any new or modified code, instead of any of the other string formatting methods. -* pmbootstrap should run on any Linux distribution, so we support all active - Python versions (see [here](https://www.python.org/downloads/)). +* pmbootstrap should run on any Linux distribution, so we support [all active + Python versions](https://www.python.org/downloads/). * ruff is used to enforce a consistent code style, it is run in CI and can be easily run locally too (see Linting down below). * Docstrings below functions are formatted in `reST` style: diff --git a/README.md b/README.md index a0248e72..bef6137b 100644 --- a/README.md +++ b/README.md @@ -22,8 +22,7 @@ pytest -vv ./test/test_keys.py ## Issues -Issues are being tracked -[here](https://gitlab.postmarketos.org/postmarketOS/pmbootstrap/-/issues). +[Issues are being tracked in the GitLab issue tracker](https://gitlab.postmarketos.org/postmarketOS/pmbootstrap/-/issues). ## Requirements