Mirror/pmbootstrap
1
0
Fork 1
mirror of https://gitlab.postmarketos.org/postmarketOS/pmbootstrap.git synced 2025-07-12 10:59:49 +03:00
Code Issues Wiki Activity

CONTRIBUTING.md, README.md: Use descriptive links

Browse source 
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
This commit is contained in:
Newbyte 2025-05-21 22:52:10 +02:00
parent aebf99e988
commit 75bc105605
No known key found for this signature in database
GPG key ID: 4A4CED6D7EDF950A
2 changed files with 3 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

4
CONTRIBUTING.md
View file

@ -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:

3
README.md
View file

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