BartonCore/.gitmessage at main · rdkcentral/BartonCore · 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
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
#
#########################
# Start of Commit Message
#########################
#
# Header
# <type>(<scope>): <subject>
# ------- Try to limit to 50 Characters --------|


# Body
# --------------- Maximum line length is 72 Characters ---------------|


# Footer

#
#
#######################
# End of Commit Message
#######################
#
#
#
#
# Barton Commit Message Format
# =============================
#
# The following is a summary of the Barton commit message format, but
# the full specification can be found at:
# https://github.com/rdkcentral/BartonCore/blob/main/CONTRIBUTING.md#commit-message-format
#
# A Barton commit messages must be structured as follows:
#
# <header>
# <BLANK LINE>
# <body>
# <BLANK LINE>
# <footer>
#
# Where the header is mandatory and the body and footer are optional.
#
# Commit Message Header
# ---------------------
#
# Header format:
# <type>(<scope>): <subject>
#
# The header is composed of three sections:
# 1. `type` - required
# 2. `scope` - optional
# 3. `subject` - required
#
# The following are the types that should be used:
# - `build:` Modifications impacting the build system or external
#            dependencies
# - `ci:` Changes to our CI configuration files and scripts
# - `docs:` Documentation only changes
# - `feat:` A new feature
# - `fix:` A bug fix
# - `refactor:` A code change that neither fixes a bug nor adds a
#               feature
# - `revert:` A commit that reverts a previous commit
# - `style:` Changes that do not affect the meaning of the code
#            (white-space, formatting, missing semi-colons, etc)
# - `test:` Adding missing tests or correcting existing tests
# - `app:` Changes to the Reference App (`reference/`)
#
# Scopes can include device drivers, subsystems, documentation or
# nothing at all.
#
# The subject is a distinct, succinct description of the change
#
# Commit Message Body
# -------------------
#
# Explain in detail what was done in this commit and what this is
# supposed to achieve. Wrap all lines at 72 characters.
#
# Commit Message Footer
# ---------------------
#
# The footer is optional and may include details about breaking changes
# and deprecations. It is also the appropriate section to reference
# GitHub issues, Jira tickets, and other PRs that this commit closes or
# relates to.
#
#