From f98cd319650f4dd6263a757029dfc88244f30f64 Mon Sep 17 00:00:00 2001 From: Will McGugan Date: Wed, 2 Dec 2020 22:38:23 +0000 Subject: [PATCH] contributing doc --- CONTRIBUTING.md | 23 ++++++++++------------- 1 file changed, 10 insertions(+), 13 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index acd5d6c0..25c2e5d5 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,30 +1,27 @@ # Contributing to Rich -This project welcomes contributions in the form of Pull Requests. -For clear bug-fixes / typos etc. just submit a PR. -For new features or if there is any doubt in how to fix a bug, you might want -to open an issue prior to starting work, or email willmcgugan+rich@gmail.com +This project welcomes contributions in the form of Pull Requests. +For clear bug-fixes / typos etc. just submit a PR. +For new features or if there is any doubt in how to fix a bug, you might want +to open an issue prior to starting work, or email willmcgugan+rich@gmail.com to discuss it first. ## Development Environment -Rich uses [poetry](https://python-poetry.org/docs/) for packaging and -dependency management. To start developing with Rich, either install the -recommended way (using curl) as described in their -[docs](https://python-poetry.org/docs/#installation), or simply run: +Rich uses [poetry](https://python-poetry.org/docs/) for packaging and +dependency management. To start developing with Rich, install Poetry +using the [recommended method](https://python-poetry.org/docs/#installation) or run: ``` pip install poetry ``` -Once Poetry is installed, run +Once Poetry is installed, install the dependencies with the following command: ``` poetry install ``` -To install dependencies - ### Tests Run tests with the following command: @@ -43,7 +40,7 @@ New code should ideally have tests and not break existing tests. ### Type Checking -Rich uses type annotations throughout, and `mypy` to do the checking. +Rich uses type annotations throughout, and `mypy` to do the checking. Run the following to type check Rich: ``` @@ -64,4 +61,4 @@ 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. \ No newline at end of file +and use `make format` to format and write to the files.