AdGuard Go Team Git guidelines
August 14, 2025 · View on GitHub
-
§ Call your branches either
NNNN-fix-foo(whereNNNNis the ID of the GitHub / GitLab / Jira issue you worked on in this branch) or justfix-fooif there was no issue. Make sure to always spell the Jira IDs (but not the suffix) in uppercase letters to make sure it gets linked. -
§ Do not put your text editors’ temporary files into the project’s
.gitignorefiles. The more are added, the harder they become to maintain. Put them into your global.gitignorefile instead.Only build, run, and test outputs should be placed into
.gitignore, sorted, with negations at the bottom to make sure they take effect. -
§ Follow the commit message header format:
pkg: fix the network error logging issueWhere
pkgis usually the directory or Go package (without theinternal/…part) where most changes took place. If there are several such packages, or the change is top-level only, writeall. -
§ Keep your commit messages, including headers, to eighty (80) columns.
-
§ Only use lowercase letters in your commit message headers. The rest of the message should follow the plain text conventions.
The exceptions are direct mentions of identifiers from the source code and filenames like
HACKING.mdas well as issue IDs.