Skip to content

Commit b6ee7fa

Browse files
committed
docs(Hacking): new description of SCHEMA_VERSION variable
1 parent 7a06040 commit b6ee7fa

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

docs/source/contributing.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,11 @@ without them being properly documented.
2323
Run ``pip install -e .`` to install todoman and its dependencies into a
2424
virtualenv.
2525

26+
If the database is changed in a breaking way, the ``SCHEMA_VERSION`` variable
27+
in the class ``Cache`` has to be incremented to allow the cache to be recreated
28+
after todoman has been updated. An example would be adding new fields or
29+
removing old unnecessary fields and etc.
30+
2631
We use ``pre-commit`` to run style and convention checks. Run ``pre-commit
2732
install``` to install our git-hooks. These will check code style and inform you
2833
of any issues when attempting to commit. This will also run ``black`` to

0 commit comments

Comments
 (0)