Skip to content

Commit

Permalink
Get started on README changes
Browse files Browse the repository at this point in the history
  • Loading branch information
SqAtx committed Mar 23, 2024
1 parent 72d40ab commit b24f366
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -160,6 +160,21 @@ No data should be lost since it is just re-generateable build files.
[pythondevmode]: https://docs.python.org/3/library/devmode.html
[pudb]: https://pypi.org/project/pudb/

## Setting up a development environment

Now that you have installed all the dependencies and know how to run the tests,
it's possible that you would like to make code changes and submit them for
review.

We use [pre-commit](https://pre-commit.com) to run some checks that ensure that
our codebase is clean and consistent.

Install it with `pip install pre-commit`, and install the pre-commit hooks with
`pre-commit install`.

The same linters run in CI, and you can also run them with `pre-commit run
--all-files`.

# "Where is my user data and config stored?"

It depends:
Expand Down

0 comments on commit b24f366

Please sign in to comment.