From b7a4b02fa5c4a43399edab0de14e7db2a33a3990 Mon Sep 17 00:00:00 2001 From: Eugene Triguba Date: Sat, 18 Jan 2020 07:06:11 -0600 Subject: Proof read markdown files --- CONTRIBUTING.md | 13 +++++++++---- 1 file changed, 9 insertions(+), 4 deletions(-) (limited to 'CONTRIBUTING.md') diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a2e3a55..9a0dcc0 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -32,21 +32,26 @@ Here are some guidelines to keep in mind when submitting a pull request: - Unit tests are written using [pytest](https://docs.pytest.org/en/latest/). - Pre-commit pipeline: We use a pre-commit pipeline to ensure standard code format. + - Unused imports are automatically removed using `autoflake `_ + - The remaining imports are sorted using `isort `_. + - All code is automatically formatted with `black `_ + - Lastly, everything is checked by `flake8 `_. Make sure to install pre-commit before making commits. Note: if any of the items had to do any reformatting, sorting, etc., the commit will - fail. You'll have to re-add the items they fixed and try again. - - .. code-block:: + fail. You'll have to re-add the items it fixed and try again. + ```bash pre-commit install + ``` - If the pipeline is acting oddly, you can skip it with the ``--no-verify`` option to ``git push``. + If the pipeline is acting oddly, you can skip it with the ``--no-verify`` option + to ``git push``. To get started, make sure you have poetry installed and run ``poetry install`` and ``poetry shell`` to enter the virtual environment. \ No newline at end of file -- cgit v1.2.3