This project is licensed under the GNU GPL-3.0 license.
Branches: main is the main branch, for the stable version of the project. dev is the development branch, where the new features are implemented.
For the branch names, use the following pattern: type/description. For example, feature/login, fix/bug-in-register or docs/update-readme.
Commits: We are using conventional commits. For more information, check this site.
Basically, the commit message should be like this: <type>[optional scope]: <description>
Generaly used types: feat, fix, docs, style, refactor, test, chore
Pull Requests: The PRs should be made to the main branch from the feature branck. The PRs should have a title and a description, explaining what was done and why.
Python Syntax: We are using PEP8 for the Python syntax. For more information, check this site.
Basically we will use:
- camelCase for functions
- snake_case for variables
- UpperCamelCase for classes
- UPPER_CASE for constants
- 2 spaces for indentation