Mirrors/catppuccin-palette
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

docs: update python readme with better contribution instructions

Browse source
This commit is contained in:
backwardspy 2022-10-26 23:37:15 +01:00
parent f2a2ae945d
commit 42f9ee14ca
1 changed files with 16 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
python/README.md
View file

@ -38,15 +38,25 @@ mantle: #292c3c
crust: #232634 crust: #232634
``` ```
## Development ## Contribution
Install dependencies with [poetry](https://python-poetry.org): If you are looking to contribute, please read through our
[CONTRIBUTING.md](https://github.com/catppuccin/.github/blob/main/CONTRIBUTING.md)
first!
### Setup
This project is maintained with [Poetry](https://python-poetry.org). If you
don't have Poetry yet, you can install it using the [installation
instructions](https://python-poetry.org/docs/#installation).
Install the project's dependencies:
```bash ```bash
poetry install poetry install
``` ```
## Code Standards ### Code Standards
Before committing changes, it is recommended to run the follow tools to ensure Before committing changes, it is recommended to run the follow tools to ensure
consistency in the codebase. consistency in the codebase.
@ -59,5 +69,7 @@ mypy .
pytest --cov pytest --cov
``` ```
These tools are all installed as part of the `dev` dependency group. These tools are all installed as part of the `dev` dependency group with
Poetry. You can use `poetry shell` to automatically put these tools in your
path.