팀 내 협의한 프로젝트 수행 규칙

[SonHyeWon]

세종대학교 2020-1 오픈소스SW개론 5조

SnakeGame 클린코드 개선 및 기능 추가 프로젝트

회의를 거쳐 팀 전원이 동의한 수행 규칙을 댓글로 추가합니다.

[SonHyeWon]

1. 커밋 메시지 양식

[카테고리] 대제목(50자 이내)

세부 내용(200자 이내)

모두 영어로 작성합니다. 카테고리는 대괄호로 감싼 후, 한 칸 띄고 대제목을 작성합니다. 카테고리는 약어를 대문자로 기재합니다. NEW: 추가 MOD: 수정 BUG: 오류개선 DEL: 삭제 대제목의 첫 글자는 대문자이며, 맨 뒤에는 온점을 넣지 않습니다.

대제목 작성 후, 한 칸 개행을 두고 세부 내용을 작성합니다. 세부 내용에는 문단 들여쓰기를 하지 않고, 각 문장의 첫 글자만 대문자로 기재합니다.

[SonHyeWon]

2. 이슈 템플릿

제목 (자유롭게 서술)

내용:
해당 파트 언급/문제상황
개선을 위해 수행한 내용
원하는 작동 방식

위 내용의 커스텀 이슈 템플릿이 등록되어있습니다. 모두 한글로 작성합니다. 작성 시 Assignees, Labels, Projects, Milestone을 반드시 기재합니다.

[SonHyeWon]

3. 브랜치 이름 규칙

접두어_기능

접두어는 소문자로 기재합니다. new: 추가 mod: 수정 bug: 오류개선 del: 삭제 기능은 lowerCamelCase를 따라 브랜치의 기능을 포함하여 작성합니다.

[SonHyeWon]

4. stable한 코드

stable한 코드는 master 브랜치에 유지합니다. master 브랜치로의 merge는 팀원의 과반수가 pull requset에 동의했을 때 진행합니다.

[SonHyeWon]

5. 버전관리

0.n 버전에서 클린코드화를 진행합니다.

0.1 매크로 변수 이름 변경 └ 0.1.1 매크로 변수 이름 변경

0.2 새로운 구조체 구현 및 구조체를 헤더로 이동 └ 0.2.1 매크로 변수 및 구조체를 헤더로 이동 └ 0.2.2 새로운 구조체 구현

0.3 함수화로 함수 구현 및 헤더로 이동 └ 0.3.1 오브젝트 초기화 함수 구현 └ 0.3.2 UI 출력 함수 구현 └ 0.3.3 헤더파일 추가 및 값을 비교하는 함수 구현 └ 0.3.4 뱀 머리 방향 변경 함수, 키보드 입력 함수 구현 └ 0.3.5 뱀 몸통 이동 함수 구현 └ 0.3.6 뱀과 과일의 충돌 함수화 └ 0.3.7 화면 지우기 함수 구현 └ 0.3.8 뱀 머리 이동 함수 구현 └ 0.3.9 오브젝트 그리기 함수화

0.4 형식 통일 및 함수 삭제 └ 0.4.1 형식 통일 └ 0.4.2 미사용 함수 삭제

0.5 주석 추가 └ 0.5.1 주석 추가

1.n 버전부터 기능을 추가합니다.

1.1 바운더리 만들기 └ 1.1.1 바운더리 만들기 └ 1.1.2 바운더리 구현 방식 변경

1.2 충돌체크 └ 1.2.1 맵과 충돌 체크 └ 1.2.2 몸통 충돌 체크 └ 1.2.3 종료 조건

1.3 조건 추가 └ 1.3.1 뱀의 방향을 바꾸는 조건 추가

1.4 게임 종료 처리 └ 1.4.1 게임 종료 시 화면 유지

[SonHyeWon]

6. 풀 리퀘스트 양식

제목: [버전] 주요 수행 내용

내용:
1. 커밋1 설명
2. 커밋2 설명
3. 커밋3 설명
....

모두 한글로 작성합니다. 제목의 버전은 대괄호로 감싼 후, 한 칸 띄고 PR의 주요 내용을 작성합니다. 주요 수행 내용의 맨 뒤에는 온점을 넣지 않습니다.

내용으로는 PR의 커밋 내역을 간단하게 설명합니다. 작성 시 Labels, Projects, Milestone을 반드시 기재합니다.