Create commit message template
Closed this issue ยท 10 comments
Create commit message template and write it in wiki page
Proposal
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 <Optional if it exists>
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/build-webos/issues#1
Signed-off-by: Yi-Soo An <email@email.com>
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: Issue <Optional, see the first case>
Signed-off-by: author <author's email>
For example,
Add debug option
To allow users debug the app at runtime, add debug option.
include:
main.c
application.c
window.c
Fix: #1
Signed-off-by: Yi-Soo An <email@email.com>
For Your Information
- The case of number 2 could include a few files in a commit.
Fix
could be asrepo/issues#<number>
or just#<number>
-- See #1 (comment) about it in further detail.
@memnoth
Issue ๋ฒํธ๋ฅผ ๋ฌ๋๋ https://help.github.com/articles/closing-issues-using-keywords/ ๋ฅผ ์ฐธ๊ณ ํด์ ์ ์ฒด URL์ด ์๋ "fix #1" ์ด๋ฐ์์ผ๋ก ๋ฌ์๋ ๊ด์ฐฎ์ ๊ฒ ๊ฐ์ต๋๋ค.
ํ ๊ฐ์ง ๋ด์ฉ์ผ๋ก ์ฌ๋ฌ ํ์ผ์ ํ๋ฒ์ ์์ ํ๋ ๊ฒฝ์ฐ๋ ์๋๋ฐ ๊ทธ๋ฐ ๊ฒฝ์ฐ๋ ์ด๋ป๊ฒ ํ๋ฉด ์ข์๊น์
@sukdo399 ๊ทธ ๊ฒฝ์ฐ๋ 2๋ฒ ํ ํ๋ฆฟ์ ํฌํจ๋ ๊ฒ ๊ฐ์์ ๊ด๋ จ๋ด์ฉ์ ์์ ํ์์ต๋๋ค.
@sukdo399 ๋ง์ํด์ฃผ์ ํ ์ปค๋ฐ์ ์ฌ๋ฌํ์ผ์ด ์์ ๋๋ ๊ฒฝ์ฐ๋ ์ปค๋ฐ ๋ฉ์ธ์ง์ ํ์ผ ์ด๋ฆ์ ํฌํจํ๋๊ฑด ์ด๋จ๊น์? ์์ ์์ ๋ฅผ ์ถ๊ฐํด์ ์์ ํ์ต๋๋ค.
@memnoth ํ์ผ ์ด๋ฆ์ ๋ค ์ ๋ ๊ฒ์ commit message ์์ฒด๊ฐ ๋ณต์กํด ๋ณด์ด์ง ์์๊น์? ์์ญ๊ฐ ์ด์ ์์ ํ๋ ๊ฒฝ์ฐ๋ ์๊ฐ๋ณด๋ค ๋ง๊ณ ์. ๊ทธ๋ฆฌ๊ณ diff๋ git log์๋ ์์ ํ ํ์ผ ๋ชฉ๋ก๋ค์ ๋์ค๊ธฐ ๋๋ฌธ์ ์ ๋ ํ์ผ ์ด๋ฆ๊น์ง๋ ๋ค ์ ์ง ์์๋ ์ข๊ฒ ๋ค๊ณ ๊ฐ์ธ์ ์ผ๋ก ์๊ฐํ๋๋ฐ ๋ค๋ฅธ ๋ถ๋ค ์๊ฒฌ๋ ํ๋ฒ ๋ค์ด๋ณผ๊น์
@sukdo399 ์ ๊ทธ๋ฐ๊ฒฝ์ฐ๋ ์์ ์ ์๊ฒ ๋ค์. ์ ๋ ๋ค๋ฅธ ๋ถ๋ค ์๊ฒฌ์ ๋ค์ด๋ณด๋๊ฒ๋ ์ข๋ค๊ณ ์๊ฐํฉ๋๋ค.
-
์ปดํฌ๋ํธ
์์ ๋ด์ญ๋ง ์ ์ด๋ ๋ ๊ฒ ๊ฐ์ต๋๋ค. -
meta layer
ํ์ผ ํ๊ฐ๋ ์ ๋๊ฒ ์ข์ ๊ฒ ๊ฐ๊ณ ์. ์ฌ๋ฌ๊ฐ๋ฉด ํฐ ์ ๋ชฉ๋ง ๋ถ์ด๋ฉด ๋ ๊ฒ ๊ฐ์ต๋๋ค. ๊ทธ๋ฆฌ๊ณ ์ปดํฌ๋ํธ ์์ ์ฌํญ์ ์ปดํฌ๋ํธ ์ด๋ฆ์ผ๋ก ์ ์ผ๋ฉด ์ข์ ๊ฒ ๊ฐ๊ณ ์.
please see https://github.com/webosce/README/wiki/Commit-Message-Template and close this issue.