1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39
|
# Contribution guide
## Development install
```sh
git clone https://github.com/mondeja/mkdocs-include-markdown-plugin
cd mkdocs-include-markdown-plugin
pip install hatch
```
## Test
```sh
hatch run tests:unit
# `hatch run tests:integration`
# `hatch run tests:all`
# `hatch run tests:cov`
```
## Linting and translations processing
```sh
hatch run style:lint
```
## Release
```sh
version="$(hatch run bump <major/minor/patch>)"
git add .
git commit -m "Bump version"
git push origin master
git tag -a "v$version"
git push origin "v$version"
```
## Compatibility
Latest version supporting Python3.7 and Mkdocs<1.4.0 is v4.0.4.
|