Skip to content

Modifiying / Editing Code @ Development Guide:

You can not edit the main branch. So please open an issue before (Guide on Creating Issues). Once done open a merge request with the name created by GitLab (Guide on Creating Merge Requests).

  • Merge Request Reviewers may not understand what the code is doing at first glance so please ensure you comment on what the code is doing at every stage.
  • Please run uv run ruff check --fix to find and fix any issues with your code changes before commiting your changes.
  • You need to have Git installed on your laptop/PC to be able to access different branches and etc. Git's Website

Abstract

  • We ask for our none-web projects to be developed using Python.
  • Please follow the intent where needed. Spaces should be set to 4.

Tip

Critcal/Key changes can occur which is why we reccomend you keep your merge request's source branch up-to-date. To do enter the command below into your IDE's Git Terminal:

git pull origin main

Commit Naming:

Please look at the examples below on how to name your commits.

  1. fix: {bug}
  2. feat: {new feature name}
  3. imprv: {imprv short description}
  4. qol: {qol short description}