Commit Message Template

Jump to bottom

Changhyeok Bae edited this page Aug 29, 2018 · 1 revision

1. Template for a commit of a file.

Filename without extension: Explain WHAT you did briefly

Explanation of WHY you did it. <Optional if the first line is clear>

Fix: Issue Number if it exists. <Optional>

Signed-off-by: author <author's email>

For example,

main: Add debug toggle option

To allow users debug the app at runtime, toggle option is needed.

Fix: webosce/README#1 : Issue if it exists. <Optional>

Signed-off-by: author <author's email>

2. Template for a commit of a feature.

Explain WHAT you did briefly

Explanation of WHY you did it, but it should be in more detail.

Fix: webosce/README#1 : Issue if it exists. <Optional>

Signed-off-by: author <author's email>

FYI, The case of number 2 could include a few files in a commit.