컨벤션 작성 가이드

👐 컨벤션

md 파일 작성 방법

• 폴더와 파일명은 모두 영문 소문자로 작성한다.(공백은 '_'으로 채운다)

• 맨앞에 category를 포함해서 작성한다.

• 해당 문서를 다시 봤을 때, 추가적인 검색의 비용이 들지 않도록 쉽고 단순하게 작성한다.

• 제목이 길어져도 이해를 우선시하여 작성한다.

• 예) CPU 스케줄링 알고리즘 -> os_cpu_scheduling_and_algorithm.md

Commit 컨벤션

파일 생성 시 docs: [카테고리] md 파일 명
이미지 파일 업로드 시 add: [카테고리] 커밋 메시지
파일 내부 수정 시 chore: [카테고리] 커밋 메시지
파일명 수정 시 rename: [카테고리] 커밋 메시지
오류 처리시 fix: [카테고리] 커밋 메시지


CPU 스케줄링 알고리즘
예) docs: [OS] CPU 스케줄링 알고리즘
예) add: [OS] 파일 추가
예) chore: [OS] 내용 추가
예) rename: [OS] 이름 수정
예) fix: [OS] 오류 처리