Rules Hub

Coding Rules Library

← Back to all rules

Rule priority, scope & exceptions

Use this to align rules with the senior-level structure (P0/P1/P2, scope, exceptions/tradeoffs).

PriorityP2 — style, consistency, readabilityScopeUniversal — language-agnostic, broadly applicable

Exceptions / tradeoffs (EN)Iznimke / tradeoffi (HR)

fullstack ruleP2universalStack: any

documentationclarityconfigcomments

Expand acronyms and document non-obvious config

Spell out acronyms (e.g. GCR = Google Container Registry) and add brief comments for non-obvious config like an empty workflow_dispatch, so readers don't have to guess.

PR: hegnar-bellsheep-web · org-mining-hist-2026-06Created: Jun 18, 2026

Bad example

Old codeyaml

1	`# push to GCR`
2	`workflow_dispatch:`

Explanation (EN)

Objašnjenje (HR)

Good example

New codeyaml

1	`# push to GCR (Google Container Registry)`
2	`workflow_dispatch: # enables manual triggering from the Actions UI`

Explanation (EN)

Objašnjenje (HR)

Login required