mirror of
https://github.com/apache/nuttx.git
synced 2025-12-10 04:04:18 +08:00
8f130b78a9
Introduces a commit message template with instructions in the contributing documentation about how to set it up. This way users are reminded of what makes a "good" NuttX commit as they write their commit, and don't need to re-consult the documentation every time. Signed-off-by: Matteo Golin <matteo.golin@gmail.com>
21 lines
933 B
Plaintext
21 lines
933 B
Plaintext
# EXAMPLE: net/can: Add g_ prefix to can_dlc_to_len and len_to_can_dlc.
|
|
maintopic/subtopic: Short, explanatory context about this commit.
|
|
|
|
Here you should write a description on what's changed, how, and why. You
|
|
can use several lines, short sentences or even bullet points. You can
|
|
even mention a specific issue/pull request using `#` followed by the
|
|
numerical ID. For more pointers, please see `nuttx/CONTRIBUTING.md`.
|
|
|
|
# Don't forget to run `git commit` with the `-s` option to sign-off your
|
|
# commit!
|
|
|
|
# Some questions to help you write a clear commit message
|
|
# - What is the purpose of change?
|
|
# - Why it is necessary
|
|
# - What it does / adds / fixes
|
|
# - How things are added / changed / fixed / updated
|
|
# - What is the impact (build / runtime / api / what area)
|
|
# - How it was tested (build host, compiler, target, logs)
|
|
# - References (i.e. nuttx and nuttx-apps changes).
|
|
# - Dependencies (if change depends on another change).
|