Skip to content
This repository was archived by the owner on May 17, 2024. It is now read-only.

Commit c2ced0e

Browse files
author
Sung Won Chung
committed
update contributing guide
1 parent 7bd14cf commit c2ced0e

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

CONTRIBUTING.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,8 @@ Once inside, you can install the dependencies.
5454

5555
- Option 2: Run `pip install -e .` to install them, and data-diff, in the global context.
5656

57+
- Run `pre-commit install` to automatically format your code before committing.
58+
5759
At the bare minimum, you need MySQL to run the tests.
5860

5961
You can create a local MySQL instance using `docker-compose up mysql`. The URI for it will be `mysql://mysql:Password1@localhost/mysql`. If you're using a different server, make sure to update `TEST_MYSQL_CONN_STRING` in `tests/common.py`. For your convenience, we recommend creating `tests/local_settings.py`, and to override the value there.

0 commit comments

Comments
 (0)