Skip to content

Commit

Permalink
more info about ruff rules and configuration
Browse files Browse the repository at this point in the history
  • Loading branch information
da-maltsev committed Dec 11, 2024
1 parent 7624ea6 commit cdc1a78
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion {{ cookiecutter.name }}/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ make test # run tests
### Style

* Obey [django's style guide](https://docs.djangoproject.com/en/dev/internals/contributing/writing-code/coding-style/#model-style).
* Configure your IDE to use [ruff](https://pypi.org/project/ruff) for checking your python code. To run our linters manualy, do `make lint`.
* Configure your IDE to use [ruff](https://pypi.org/project/ruff) for checking your Python code. To run our linters manually, do `make lint`. Feel free to [adjust](https://docs.astral.sh/ruff/configuration/) ruff [rules](https://docs.astral.sh/ruff/rules/) in `pyproject.toml` section `tool.ruff.lint` for your needs.
* Prefer English over your native language in comments and commit messages.
* Commit messages should contain the unique id of issue they are linked to (refs #100500).
* Every model, service and model method should have a docstring.
Expand Down

0 comments on commit cdc1a78

Please sign in to comment.