Repository files navigation

This application manages commitfests for the PostgreSQL community.

A commitfest is a collection of patches and reviews for a project and is part of the PostgreSQL development process.

This is a Django 4.2 application backed by PostgreSQL and running on Python 3.x.

First, prepare your development environment by installing pip, virtualenv, and postgresql-server-dev-X.Y.

sudo apt install python-pip postgresql-server-dev-14

Next, configure your local environment with virtualenv and install local dependencies.

python3 -m venv envsource env/bin/activatepip install -r dev_requirements.txt

Create a database for the application:

createdb pgcommitfest

Create a local settings file (feel free to edit it):

cp pgcommitfest/local_settings_example.py pgcommitfest/local_settings.py

Now you can now create the required tables. Note that a password might need tobe provided.

./manage.py migrate

For a quick start, you can load some dummy data into the database. Here's howyou do that:

./manage.py loaddata auth_data.json./manage.py loaddata commitfest_data.json

If you do this, the admin username and password areadmin andadmin. Thereare a few other users as well (staff,normal,committer,inactive-committer), that all have the same password as their username.

On the other hand, if you'd like to start from scratch instead, you can run thefollowing command to create a super user:

./manage.py createsuperuser

Finally, you're ready to start the application:

./run_dev.py

Then openhttp://localhost:8007/admin to log in. Once redirected to the Djangoadmin interface, go back to the main interface. You're now logged in.

Code formatting and linting is done usingruff,biome, anddjhtml.You can run formatting usingmake format. Linting can be done usingmake lint and automatic fixing of linting errors can be done usingmake lint-fixormake lint-fix-unsafe (unsafe fixes can slightly change program behaviour,but often the fixed behaviour is the one you intended). You can also run bothmake format andmake lint-fix-unsafe together by usingmake fix. CIautomatically checks that you adhere to these coding standards.

You can install the git pre-commit hook to help you adhere to the codestyle:

ln -s ../../tools/githook/pre-commit .git/hooks/

If you want to discuss development of a fix/feature over chat. Please join the#commitfest-dev channel on the"PostgreSQL Hacking" Discord server

The staging server is available at:https://commitfest-test.postgresql.org/User and password for the HTTP authentication popup are bothpgtest. Themain branch is automatically deployed to the staging server. After some timeon the staging server, commits will be merged into theprod branch, whichautomatically deploys to the production server.

If you'd like to regenerate the database dump files, you can run the following commands:

./manage.py dumpdata auth  --format=json --indent=4 --exclude=auth.permission > pgcommitfest/commitfest/fixtures/auth_data.json./manage.py dumpdata commitfest  --format=json --indent=4 > pgcommitfest/commitfest/fixtures/commitfest_data.json

If you want to reload data from dump file, you can rundrop owned by postgres; in thepgcommitfest database first.