Repository navigation

Contributing

Git Hooks

Enable git hooks:

chmod +x .githooks/*
git config core.hooksPath .githooks

Allowed prefixes for commits and branches:

feat, fix, docs, refactor, perf, test, build, ci, chore, revert.

Commit message format:

<type>(<scope>)?[!]: <subject>

Where:

<type> — one of the allowed prefixes above.
<scope> — optional scope in parentheses, alphanumeric/-.
! — optional breaking change marker.
: — colon + space are required.
<subject> — short description.

Total commit message length is limited to 70 characters.

Valid commit examples:

feat: add filters to user search
fix(auth): handle invalid jwt token
refactor(user-service)!: drop legacy ws implementation
docs: update api usage section
chore(ci): tweak lint step

Branch naming format:

<type>/<slug>
<type>/<scope-or-id>/<slug>

Where:

<type> — one of the prefixes listed above.
/<scope-or-id> — optional part, alphanumeric/-.
/<slug> — short description, alphanumeric/_/-.

Valid branch examples:

feat/add-user-search-filters
fix/schedule-update-ws-event
refactor/core-user-cleanup
feat/GOTEC-404/add-notifications-for-users

Exceptions: dev, main, master.