Skip to content

Commit da3053d

Browse files
CONTRIBUTING.md: Fix Markdown format for linting
Signed-off-by: Bernhard Kaindl <bernhard.kaindl@cloud.com>
1 parent 65bd4a9 commit da3053d

1 file changed

Lines changed: 20 additions & 15 deletions

File tree

CONTRIBUTING.md

Lines changed: 20 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -47,15 +47,18 @@ sudo apt-get install -y python3.{8,11}{,-distutils}
4747
Installation of additional python versions for testing different versions:
4848

4949
- If `deadsnakes/ppa` does not work, e.g. for Python 3.6, `conda` or `pyenv` can be used.
50-
For instructions, see https://realpython.com/intro-to-pyenv:
51-
```yaml
50+
For instructions, see <https://realpython.com/intro-to-pyenv>:
51+
52+
```bash
5253
sudo apt install -y build-essential xz-utils zlib1g-dev \
5354
lib{bz2,ffi,lzma,readline,ssl,sqlite3}-dev
5455
curl https://pyenv.run | bash # add displayed commands to .bashrc
5556
~/.pyenv/bin/pyenv install 3.{6,8,11} && ~/.pyenv/bin/pyenv local 3.{6,8,11} # builds them
5657
```
58+
5759
- For testing on newer Ubuntu which has `python2-dev`, but not `pip2`, install `pip2` this way:
58-
```yml
60+
61+
```bash
5962
curl https://bootstrap.pypa.io/pip/2.7/get-pip.py --output get-pip.py;sudo python2 get-pip.py
6063
```
6164

@@ -76,14 +79,14 @@ This project uses `tox` to run the tests for different python versions. Intro:
7679

7780
> _"Managing a Project's Virtual environments with `tox` -
7881
> A comprehensive beginner's introduction to `tox`":_
79-
> https://www.seanh.cc/2018/09/01/tox-tutorial/
82+
> <https://www.seanh.cc/2018/09/01/tox-tutorial>
8083
81-
`tox` runs `pytest`, `pylint` and static analysis using `mypy`, `pytype`, and `pyright`.
84+
`tox` runs `pytest`, `pylint` and static analysis using `mypy`, `pyre`, `pytype`, and `pyright`.
8285
Links:
8386

84-
- https://mypy.readthedocs.io/en/stable/
85-
- https://microsoft.github.io/pyright/
86-
- https://google.github.io/pytype/
87+
- <https://mypy.readthedocs.io/en/stable>
88+
- <https://microsoft.github.io/pyright>
89+
- <https://google.github.io/pytype>
8790

8891
With `tox`, developers can run the full test suite for Python 2.7 and 3.x.
8992
The same test suite is used in GitHub CI:
@@ -140,13 +143,15 @@ pip install "pytest<7" pytest-picked pytest-sugar pytest-clarity # pytest-icdiff
140143
```
141144

142145
To verify or extract the dependencies and extras configured in `pyproject.toml` and `tox.ini`
143-
for specific `tox` environments, you can use https://pypi.org/project/tox-current-env/:
146+
for specific `tox` environments, you can use
147+
<https://pypi.org/project/tox-current-env>:
144148

145149
```bash
146150
tox --print-deps-to=pytype-deps.txt --print-extras-to=pytype-extras.txt -e pytype
147151
```
148152

149-
For more information to debug `pytest` test suites see: https://stribny.name/blog/pytest/
153+
For more information to debug `pytest` test suites see
154+
<https://stribny.name/blog/pytest>:
150155

151156
## Running GitHub actions locally using `act`
152157

@@ -204,7 +209,7 @@ docker run -it --rm alpine:latest grep NAME /etc/os-release
204209

205210
Ubuntu 22.04 LTS uses `iptables-nft` by default.
206211
Switch to `iptables-legacy` so that Docker will work:
207-
https://crapts.org/2022/05/15/install-docker-in-wsl2-with-ubuntu-22-04-lts/
212+
<https://crapts.org/2022/05/15/install-docker-in-wsl2-with-ubuntu-22-04-lts>
208213

209214
### Copy selection on selecting test (without need for Ctrl-C)
210215

@@ -213,11 +218,11 @@ to the X selection/clipboard for pasting it. To use this engrained behavior
213218
on Windows as well, it seems the only reliable way to have it for all apps
214219
is a `AutoHotKey` script:
215220

216-
- https://www.ilovefreesoftware.com/30/tutorial/auto-copy-selected-text-clipboard-windows-10.html
221+
- <https://www.ilovefreesoftware.com/30/tutorial/auto-copy-selected-text-clipboard-windows-10.html>
217222

218223
While individual extensions for VS Code, Firefox, chrome do work partially,
219224
they either don't cover the Firefox URL bar, the VS Code terminal and so on:
220225

221-
- https://addons.mozilla.org/en-GB/firefox/addon/copy-on-select
222-
- https://marketplace.visualstudio.com/items?itemName=dinhani.copy-on-select (VS Code)
223-
- https://www.jackofalladmins.com/knowledge%20bombs/dev%20dungeon/windows-terminal-copy-selection/
226+
- <https://addons.mozilla.org/en-GB/firefox/addon/copy-on-select-2>
227+
- <https://marketplace.visualstudio.com/items?itemName=dinhani.copy-on-select> (VS Code)
228+
- <https://www.jackofalladmins.com/knowledge%20bombs/dev%20dungeon/windows-terminal-copy-selection/>

0 commit comments

Comments
 (0)