Skip to content

Commit

Permalink
Adding guidelines for Black and isort
Browse files Browse the repository at this point in the history
  • Loading branch information
mrl280 committed Mar 19, 2024
1 parent 36e95d6 commit 0760427
Showing 1 changed file with 12 additions and 4 deletions.
16 changes: 12 additions & 4 deletions .github/CODING.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,9 +32,15 @@ automatically integrated into the RIA CLI.

### Python-specific guidelines

We use [Flake8](https://flake8.pycqa.org/en/latest/) for code linting and style enforcement. All Python code must
be formatted in accordance with the Flake8 configuration settings defined in the [tox.ini](../tox.ini) file
in the root of the project.
We utilize [Black](https://black.readthedocs.io/en/stable/) for automated code formatting, with configuration
settings defined in `pyproject.toml`. Please ensure that all code contributions are auto-formatted with Black,
this is important to ensure consistent and reliably formatted code.

We rely on [isort](https://pycqa.github.io/isort/index.html) for import sorting, with configuration settings defined
in `pyproject.toml`. Please use isort to automatically organize your import statements.

We use [Flake8](https://flake8.pycqa.org/en/latest/) for code linting and style. All Python code must be formatted in accordance with the Flake8
configuration settings defined in [tox.ini](../tox.ini).

To ensure a consistent development environment, this project uses [Poetry](https://python-poetry.org/) for dependency management.
[Start here](https://python-poetry.org/docs/basic-usage/) for information on basic Poetry usage. Please refrain from making unnecessary updates to the
Expand Down Expand Up @@ -195,8 +201,10 @@ poetry run pytest
```


4. Confirm your changes are formatted in accordance with our Flake8 style configuration:
4. Confirm your changes are formatted in accordance with our Black, isort, and Flake8 style configurations:
```commandline
black .
isort .
flake8 .
```

Expand Down

0 comments on commit 0760427

Please sign in to comment.