search

Gogumalang / OSSL_Big_Project

0 stars 1 forks source link

커밋 내용 컨벤션 #9

Open Gogumalang opened 1 year ago

Gogumalang commented 1 year ago

커밋을 올릴 때 메세지를 남길 때 이 메세지도 통일성을 가지면 좋을 것 같아서 이슈를 올리고자 합니다! 제가 생각한 커밋 형식은 크게 3가지인데요. '함수 : 수정내용 ' , '파일 : 수정내용' , 'make 함수/파일'

예시로 들면 ex : 'open_file : change stack reading file ... ' ex : 'change funtion name to snake' (위의 생각한 형식에 따라 적절하게 바꾸면) -> ' all : change funtion name to snake' ex : 'make account.txt' ex : 'player.h : modify structure content' (구조체와 같이 어떤 함수에 속해있지 않을 때는 파일 명을 써도 될 듯합니다. '

이런 식으로 수정한 함수와 어떤 내용을 수정했는지, 일정한 형식을 가지고 커밋을 올리면 좋을 것 같습니다. 더 좋은 의견이나 추가하고 싶은 의견 있으면 코멘트 달아주세요! 감사합니다 :)

K-Minhyeok commented 1 year ago

좋습니다!

K-Minhyeok commented 1 year ago
Gogumalang commented 1 year ago

좋습니다! ㅎㅎ

Gogumalang commented 1 year ago

추가적으로 커밋 내용 쓸게 많다, 세부 내용을 좀 더 쓰고 싶다 싶으시면 개괄적인 내용을 쓰고 따옴표로 닫지 않고 '엔터키'를 누르게 되면 커밋 내용을 줄내림을 해서 쓸 수 있어요. 그래서 첫줄에는 큰 주제를 적고 구체적인 내용을 쓰고 싶다면 줄을 내려서 쓰면 깃허브에서 커밋 내용을 더 보기 쉽습니다! 구체적인 내용을 굳이 쓰지 않아도 되니 선택사항 입니다!

<예시> git commit -am "README.md : modify contents 어떤 내용을 수정하였습니다. 어떤 기능을 추가시켰습니다. "

git log 실행 실제 화면 -> README.md : modify contents 어떤 내용을 수정하였습니다. 어떤 기능을 추가시켰습니다.