rename make, update workflow and contributing

This commit is contained in:
Hedy Li 2020-08-21 09:20:36 +00:00
parent 9e96a40aeb
commit 1617c28281
3 changed files with 9 additions and 3 deletions

View File

@ -23,7 +23,7 @@ jobs:
poetry install
- name: Format check with black
run: |
make format
make format-check
- name: Typecheck with mypy
run: |
make typecheck

View File

@ -45,4 +45,8 @@ Please add type annotations for all new code.
### Code Formatting
Rich uses `black` for code formatting. I recommend setting up black in your editor to format on save.
Rich uses [`black`](https://github.com/psf/black) for code formatting.
I recommend setting up black in your editor to format on save.
To run black from the command line, use `make format-check` to check your formatting,
and use `make format` to format and write to the files.

View File

@ -1,7 +1,9 @@
test:
pytest --cov-report term-missing --cov=rich tests/ -vv
format-check:
black --check .
format:
black --check rich tests
black .
typecheck:
mypy -p rich --ignore-missing-imports --warn-unreachable
typecheck-report: