We have a code of conduct, please make sure to review it prior to contributing.
hooks/pre-commitfile which can be used as a
pre-commitgit hook to check coding style.
npmscripts are provided (
If you want to translate the webapp, just create a new folder in
flatisfy/web/js_src/i18n with the short name of your locale (typically,
is for english). Copy the
flatisfy/web/js_src/i18n/en/index.js file to this
new folder and translate the
flatisfy/web/js_src/i18n/index.js file to include your new
master. Again, this is something nice to have that I expect from recurring contributors, but not a big deal if you don’t do it otherwise.
To enable a new Weboob
CapHousing backend in Flatisfy, you should add it to
the list of available backends in
and update the list of
BACKEND_PRECEDENCES for deduplication in
If you want to add new data files, especially for public transportation stops (to cover more cities), please follow these steps:
flatisfy/data_files. Please, use the original data file to ease tracking licenses and be able to still have a working pipeline, by letting the user download it and place it in the right place, in case of license conflict.
README.md, in the dedicated section.
flatisfy/data_files/__init__.py. You can have a look at the existing functions for a model.
If you want to change the database schema, you should create a matching migration. Here is the way to do it correctly:
flatisfy/modelsfiles to create / remove the required fields. If you create a new database from scratch, these are the files which will be used.
alembic revision -m "Some description"in the root of the git repo to create a new migration.
migrations/folder to add the required code to alter the database (both upgrade and downgrade).