O2 코드의 기본 원칙은 Vue.js 의 Style Guide를 따른다. '클린 코드'와 '읽기 좋은 코드가 좋은 코드' 책을 참고하여 세부 원칙을 세운다. 대부분의 코드 컨벤션은 eslint와 prettier로 작성되어 코드 내 강제화 한다. 위의 플러그인으로 강제화 하지 못하는 규칙은 코드 리뷰 시 확인 해야 할 사항 1순위로 정해진다.
코드를 커밋할때 다음과 같은 규칙을 기본적으로 지켜야 한다. 다음의 규칙을 지키않으면 코드 리뷰시 반드시 리뷰어는 피드백을 해야한다.
제목
50자 미만, 마지막에 마침표(.)는 넣지 않음
'[tag][menu]제목+개행' 의 포맷.
**기능(feat)**: 새로운 기능을 추가
수정**(fix)**: 버그 수정및 코드의 주요 부분 수정하는 경우
**리팩토링(refactor)**: 코드 리팩토링
**형식(style)**: 코드 형식, 정렬, 주석 등의 변경(동작에 영향을 주는 코드 변경 없음)
**테스트(test)**: 테스트 추가, 리팩토링(제품 코드 수정 없음, 테스트 코드에 관련된 모든 변경에 해당)
**문서(docs)**: 문서 수정(제품 코드 수정 없음)
**기타(chore)**: 빌드나 패키지 설정 등 위에 해당되지 않는 모든 변경(제품 코드 수정 없음)
커밋 유형들이 복합적인 경우 최대한 분리하여 커밋한다.
본문
나쁜 예
추가예정..
좋은 예
**[fix][Report]선수 이름 검증 함수 수정**
123이상 입력시에 오버플로 이슈발생으로 인해 QA팀과 상의 후 255로 검증 룰 재정의
issues:#77