euphony-io / sound-helper

Euphony Demo for patients and assistants in case of an emergency.
Apache License 2.0
5 stars 4 forks source link

Commit message rule creation #4

Open judemin opened 3 years ago

judemin commented 3 years ago

커밋 메시지와 양식 정하기 최대한 직관적이게 설정

judemin commented 3 years ago

저는 지금까지 아래와 같은 양식을 많이 사용했습니다! 커밋 타입 : 커밋 내용 (커밋 타입은 소문자 동사, 커밋 내용은 문장형) ex)

add : Add data transfer function
test : Tested some performances of new dataset

여기서 커밋 타입에 대해 규칙을 정하거나 아예 양식을 다르게 잡아도 좋을 것 같은데 다른 분들은 어떻게 생각하시나요?

kmsaidev commented 3 years ago

I think it'll be okay to do as it is.

judemin commented 3 years ago

Then what kinds of tags could we use?

Form

Tag : commit message
kuro11pow2 commented 3 years ago

How about this form?

tag : commit title

[commit message]
* Description of where the change was made
* Explanation of the reason for the change
* Description of how it was changed

I think a commit message with enough information is needed to facilitate maintenance.

eunzinn commented 3 years ago

I looked it up, and I think we need these.

fix : Fixed a error
set : Simple modification (like Changed the color or variable name etc..)
remove : Deleted a code

I'll see if there's anything else.

judemin commented 3 years ago

Commit Form

tag : commit title

[commit message]
* Description of where the change was made
* Explanation of the reason for the change
* Description of how it was changed

Tag

add : add something
update : Simple modification (like Changed the color or variable name etc..) not err
fix : Fixed an error
test : test something (not important, just for test)
remove : Deleted a code

These tags might be enough for now. When we need more tags pls add tags in this issue.