File tree Expand file tree Collapse file tree 1 file changed +4
-16
lines changed Expand file tree Collapse file tree 1 file changed +4
-16
lines changed Original file line number Diff line number Diff line change @@ -10,31 +10,20 @@ Thanks for considering to contribute to this project! Some guidelines:
1010
1111## Unit Tests
1212
13- Make sure to install an editable version before running tests:
13+ We use ` uv ` .
1414
1515``` python
16- pip install - r tests/ test_requirements.txt
17- pip install - e .
18- pytest -- cov= mkdocs_git_authors_plugin -- cov- report term- missing tests
16+ uv run pytest -- cov= mkdocs_git_authors_plugin -- cov- report term- missing tests
1917```
2018
2119If it makes sense, writing tests for your PRs is always appreciated and will help get them merged.
2220
23- In addition, this project uses pyflakes for static code checking:
24-
25- ``` python
26- pip install pyflakes
27- pyflakes tests/ mkdocs_git_authors_plugin/
28- ```
29-
3021## Manual testing
3122
3223To quickly serve a website with your latest changes to the plugin use the sites in our tests suite. For example:
3324
3425``` python
35- pip install - r tests/ test_requirements.txt
36- pip install - e .
37- mkdocs serve - f ./ tests/ basic_setup/ mkdocs_complete_material.yml
26+ uv run mkdocs serve - f ./ tests/ basic_setup/ mkdocs_complete_material.yml
3827```
3928
4029## Code Style
@@ -43,11 +32,10 @@ Make sure your code *roughly* follows [PEP-8](https://www.python.org/dev/peps/pe
4332
4433We use google-style docstrings.
4534
46-
4735## Documentation site
4836
4937Manually deployed by Tim Vink using
5038
5139``` bash
52- mkdocs gh-deploy
40+ uv run mkdocs gh-deploy
5341```
You can’t perform that action at this time.
0 commit comments