Skip to content

Commit 61e961a

Browse files
authored
Update contributing guidelines
1 parent 0794c4c commit 61e961a

File tree

3 files changed

+25
-1
lines changed

3 files changed

+25
-1
lines changed

CONTRIBUTING.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,4 +38,15 @@ They need to be deployed manually:
3838

3939
```bash
4040
mkdocs gh-deploy --force
41-
```
41+
```
42+
43+
## Release
44+
45+
Update `setup.py`.
46+
47+
```bash
48+
git tag <version>
49+
git push origin <version>
50+
```
51+
52+
Then manually create a github release to trigger publishing to pypi.

Makefile

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
2+
setup:
3+
pip install -r tests/test_requirements.txt
4+
pip install -e .
5+
6+
test:
7+
pyflakes tests/ mkdocs_table_reader_plugin/
8+
pytest --cov=mkdocs_table_reader_plugin --cov-report term-missing tests
9+
10+
deploy_docs:
11+
mkdocs gh-deploy --force

tests/test_requirements.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@ codecov
44
click
55
xlrd>=1.0.0
66
openpyxl
7+
# linting
8+
pyflakes
79
# documentation
810
mkdocs-material
911
mkdocs-markdownextradata-plugin

0 commit comments

Comments
 (0)