3. Project Rule

1) Commit 메세지 작성 방법

• 제목과 본문을 한 줄 띄워 분리하기
• 제목은 영문 기준 50자 이내로
• 제목 첫글자를 대문자로
• 제목 끝에 . 금지
• 제목은 명령조로
• 본문은 영문 기준 72자마다 줄 바꾸기
• 본문은 어떻게보다 무엇을, 왜에 맞춰 작성하기
• Colab에서 생성된 파일은 Colaboratory를 통해 생성됨 그대로 작성
  
  

2) Branch 이름

3) 변수 작성 방법

• 변수는 한 목적으로만 사용하기
• 변수는 항상 소문자로 시작하고, 다음 단어는 대문자로 구분하기
• 함수의 매개변수 역시 그 의미를 명확히 표현하는 단어로 작성하기
  
  

4) 함수 작성 방법

• 함수명은 항상 대문자로 시작하고, 다음단어는 대문자로 구분하기
• 변수명과 함수명을 같게 하지 말기
• 함수의 접두사 공통으로 사용하기
  
  

5) 버전 표기 기준

Issue #39에서도 확인 가능합니다.

x.y.z_부연설명 기준으로

• x: 전체적인 진행도

0: 크롤링
1: 전처리
2: 모델
3: ui
4: 텀프로젝트 기준 완성
5: 텀프로젝트 이후 작업

• y: 코드 관련

0: 텀프로젝트 최종본
1: 코드가 없거나 수정사항이 없음
2: 코드 수정(생성 및 추가)
3: 코드 삭제

텀프로젝트 이후로는
1,2,3만 사용

• z: 코드 파일을 제외한 파일 관련

0: 텀프로젝트 최종본
1: 파일 없거나 수정사항이 없음
2: 파일 수정(생성 및 추가)
3: 파일 삭제

텀프로젝트 이후로는
1,2,3만 사용

• 부연설명: 필요 시 간단하게
  
  

6) Merge 규칙

(1) Merge 확인 작업

각자 맡은 코드 수정 후, Issue 표에 수정한 내용을 정리한다.
팀원은 Pull request에 있는 해당 Issue를 보고 피드백을 남긴다.(merge 찬성 혹은 개선 내용 추가)
과반수 이상이 찬성했을 시 merge 결정

(2) Merge 결정 후

Merge를 하기로 결정났으면 merge를 진행한다.

7) Issue 규칙

한 기능 당 하나의 issue를 생성하여, 댓글을 통해 의견을 주고받는다. 질문이나 일정 등 의견을 주고받을 때는 issue를 이용한다.

8) 문서화 규칙

수정할 곳에 관한 issue를 생성하여, 댓글을 통해 피드백을 남긴다.