Day 14 - 커밋 컨벤션 설정 & README.md 작성

• 주제

1. Commit Message Convention (깃허브데스크탑)

2. README.md

---

• 공부내용

1. Commit Message Convention (깃허브데스크탑)

다른 개발자와 협업을 위해 필요한 규칙으로, Git(GitHub)에서 커밋 메세지를 작성할 때 적용된다.

 

 

>깃허브데스크탑 내에서 commit 화면을 캡쳐한 것이다.

 

 

 

1. Summary(required)

= 타입: 제목(변경사항이 무엇인지 명확히 작성) 

제목은 간결하게 50자 이내로 작성.

끝에 마침표 금지.

ex) feat: 로그인 기능 추가

 

2. Description

= 본문(무엇을 왜 추가하고 고쳤는지 작성)

또는 푸터(둘 다 생략가능)

적는다면 상세히 기록.

**푸터(꼬릿말): 이슈 트래킹을 위해 작성

ex) Close #7

타입	내용
feat	새로운 기능 추가
fix	버그 수정
docs	문서 수정(readme 수정)
refact	코드 리팩토링(코드 가독성을 높임)
style	코드 의미에 영향을 주지 않는 변경사항
chore	빌드 부분 혹은 패키지 매니저 수정사항
test	테스트 코드 추가 및 수정

 

 

참조사이트

https://growingarchive.tistory.com/m/344

[Git] Git Commit Message Convention

---

2. README.md란?

Github에 프로젝트를 올릴 때, 프로젝트에 대한 설명뿐 아니라 기능, 사용방법, 라이선스 정보 등을 적는

마크다운 언어 파일이다.

 

참조사이트

https://gist.github.com/ihoneymon/652be052a0727ad59601

마크다운(Markdown) 사용법