Home

Welcome to the arch-spatula.github.io wiki!

커밋 컨벤션

type: title #이슈번호

- body(3줄 이하 권장)

기본형식입니다.

커밋 유형

글쓰기 커밋

• 아티클을 작성하는데 대략적인 컨벤션을 정합니다. 글을 단계적으로 발전시키기 위한 방법입니다.
• 글쓰기 자체는 순환적이라 무조건 단계별로 작성할 필요는 없습니다. 그저 생각을 쉽게 정리하기 위한 가이드에 불과합니다.

invention:

• 발상 단계입니다.
• 생각난 아이디어를 자유롭게 작성합니다.
• 목차와 단락의 역할을 작성합니다.

planning:

• 계획 단계입니다.
• 임의의 마감이라도 정합니다.
• 어떤 자료가 필요할지 정합니다.

drafting:

• 초고 단계입니다.
• 문단을 역할에 맞게 채웁니다.

revising:

• 수정 단계입니다.
• 내용적인 수정입니다. 작성하면서 중간에 생각이 바뀔 수 있습니다.

editing:

• 편집 단계입니다.
• 내용적으로는 동일하고 표현, 문법, 맞춤법, 표기법에 대한 수정입니다.

개발 관련 커밋

feat:

새로운 기능, 특징 추가

fix:

• 수정, 버그 수정

docs:

• 문서에 관련된 내용, 문서 수정

refactor:

• 리팩토링

test:

• 테스트 코드 수정, 누락된 테스트를 추가할 때, 리팩토링 테스트 추가

chore:

• 빌드 업무 수정, 패키지 매니저 수정

브랜치 생성 컨벤션입니다.

글쓰기와 관련된 브랜치

draft/

• 글의 초고와 내용적인 탈고까지 다루는 브랜치입니다.

edit/

• 나중에 확인 글을 다시보고 수정할 사항들 문법, 맞춤법 등 수정하는 브랜치입니다.

blog/(년도)-(월)-(일)

• 블로그 포스트관련된 커밋입니다. 예: blog/2023-05-16

개발과 관련된 브랜치

feat/

• 기능추가 브랜치입니다.

hotfix/

• main 브랜치에서 발견한 문제를 급하게 해결하기 위한 브랜치입니다.

refactor/

• 동작은 동일하지면 코드 퀄리티를 개선하기 위한 전용 브랜치입니다.

doc/

• 개발 문서화와 관련된 브랜치명입니다.

chore/

• 개발환경 설정과 설치와 관련된 브랜치 명입니다.