Skip to content

Latest commit

 

History

History
47 lines (47 loc) · 1.39 KB

contributing.md

File metadata and controls

47 lines (47 loc) · 1.39 KB

How to contribute

Start by searching in the TODO and Backlog columns from the project board. It is imperative that you work in your own fork. When you are done, create new pull request. Keep in the mind that you should mention all the issues that were fixed. Feel free to post any newbie topics in the Discussion tab.

Dev dependencies

poetry install --with dev,docs

Docs generation

If you want a web version of the docs:

cd docs
make html

Start autotests

Create a secret file with the db name and username:

export POSTGRES_TEST_DBNAME=...
export POSTGRES_USER=...

And export it:

source file

Then:

poetry run pytest

Note that the working directory (pwd) must be /project/. Any other path will cause an error when starting pytest.

How to update locale

locale directory contains all the msgids for translating to the current language. For updating to change a .po file in any dir of locale. Then run

msgfmt -o locale/current_language_dir/LC_MESSAGES/vtc-bot.mo locale/current_language_dir/LC_MESSAGES/vtc-bot.po"

How to get the DB up

Create a PostgreSQL database, then type

scripts/setupdb.sh <dbname> <postgresql_username>

If you want to update schema.sql, use

scripts/dumpdb.sh <dbname> <postgresql_username>

The script will automatically update schema.sql.