Avatar/.gitcommit-template at main · etan91011/Avatar · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
# <type>(<scope>): <subject>
#
# <body>
#
# <footer>

# Type should be one of the following:
# * feat: A new feature
# * fix: A bug fix
# * docs: Documentation only changes
# * style: Changes that do not affect the meaning of the code
# * refactor: A code change that neither fixes a bug nor adds a feature
# * perf: A code change that improves performance
# * test: Adding missing tests or correcting existing tests
# * chore: Changes to the build process or auxiliary tools
# * ci: Changes to CI configuration files and scripts
# * build: Changes that affect the build system or external dependencies

# Scope is optional and should be the name of the module affected:
# * bci, drone, nao, gui, ml, server, docs, etc.

# Subject line:
# * Use imperative, present tense: "change" not "changed" nor "changes"
# * Don't capitalize first letter
# * No dot (.) at the end
# * Maximum 50 characters

# Body:
# * Use imperative, present tense
# * Wrap at 72 characters
# * Include motivation for the change and contrast with previous behavior

# Footer:
# * Reference issues and pull requests
# * Breaking changes should start with "BREAKING CHANGE:"
# * Use "Closes #123" or "Fixes #123" to auto-close issues

# Examples:
# feat(bci): add support for 32-channel OpenBCI boards
# fix(drone): resolve connection timeout issues
# docs: update setup guide with new requirements
# feat(ml)!: change prediction model API
#
# BREAKING CHANGE: The prediction model now returns different format