Contributor Guidelines

All code contributions all licenced under AGPLv3

Code layout

gkcore/__init__.py contains the mapping of all REST API endpoints to their route names. Also contains the config for openapi plugin
gkcore/models/ contains database model schema of the application
gkcore/spec/ has OpenAPI spec files for the swagger ui
tests/ contains API tests
gkcore/views/ contains the logic for all API's. Each file corresponds to the specific component's API code
static/ dir has HSN/SAC code json file which is auto generated by the update_fin_codes.py script
db_migrate.py contains the db migrations code
We follow the conventional commits specification for writing commit messages

Editor Plugins

VSCode/ium

Pyright for code liniting: https://marketplace.visualstudio.com/items?itemName=ms-pyright.pyright
Black for code formatting: https://marketplace.visualstudio.com/items?itemName=mikoz.black-py&ssr=false#review-details

Neovim

Mason: Install black formatter and lsp pyright

Merge strategy

Development happens on the devel branch. Create your feature branch from it, add your changes and make a merge request

master branch is intended for stable code. So, do not push changes to it.

Release Strategy

Checklist:

Update IFSC & HSN codes with update_fin_codes.py
Git checkout to master
merge commits from devel -> master
Wait for the ci/cd pipeline to finish. Make sure all jobs are successful
Create a Release / tag

Gitlab Hacks

Closing Issues via commits: https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically