- 이 파일은 원활한 개발 진행을 위해 작성되었습니다.
- 협의된 내용만을 작성하며, 내용을 추가/수정 할 경우 추가적인 협의가 되어야 합니다.
- 엔진: UNITY 2021.3.22f1
- 코드 에디터: JetBrains Rider
- 빌드는
IL2CPP를 사용합니다. - 들여쓰기는 탭을 사용하며, 이외에는 아래의 규칙을 따라 설정합니다. (
.editorconfig기본적으로 제공된 파일을 유지하면 됩니다.)
- Asset 폴더는 각 항목별로 1차 분리합니다. (Scripts, Scenes, Fonts, ...)
- 스크립트 폴더의 경우, Scene 이름별로 2차 분리합니다.
- Namespace는
프로젝트명.Scene명으로 사용합니다. - 변수, 상수, 함수명 등의 작명은 최대한 풀어서 작성하며, 변수를 제외한 모든 이름은 첫글자를 대문자로 작성합니다. (Camel case)
- Inspector에 변수를 노출하고자 하는 경우,
public이 아닌[SerializedField]를 사용해야 합니다. - 모든 Class와 함수에 summary를 작성합니다. 이외에 enum이나 프로퍼티와 같은 다른 요소들은 필요에 따라 작성합니다.
- 개발 진행 중 발생하는 문제점은 Issue를 생성하여 관리합니다.
- Issue는 자유 양식으로 작성해도 되나, 사전에 생성된 템플릿을 사용하는 것을 권장합니다.
- 모든 Issue에는 담당자와 라벨, 프로젝트가 지정되어야 합니다.
- Pull Request(이하 PR)는 개발 branch와 main, 또는 개발 branch끼리 이루어질 수 있습니다.
- PR이 승인되기 위해서는 PR을 오픈한 당사자를 제외한 참여자 모두의 승인이 필요합니다.
- 각 참여자는 PR로 인해 생길 수 있는 문제를 확인 한 후 승인해야 합니다.
- 각자 GitHub 닉네임으로 만들어진 Branch에 커밋 후, merge하는 방식으로 진행합니다.
- 커밋 제목은
YYYYMMDDa로 진행합니다. - 이 때
a는 연번이며, 하루에 여러번 커밋 할 경우b, c, d, ...로 바꾸면서 커밋합니다. - 커밋 내용은 Scene별로 작업한 내용을 서술하며, 연관된 Issue가 있을 경우 해당 Issue의 번호도 같이 기술합니다.
- 아래 예시를 참고하세요.
20230131d
ㅤ
[공통]
- 엔진 업데이트 (2022.1.20f1 -> 2022.1.21f1)
ㅤ
[GameScene]
- 플레이어 판정 조정
ㅤ
[LobbyScene]
- 항목 설명이 뜨지 않던 버그 수정 (#3)