-
Notifications
You must be signed in to change notification settings - Fork 1
Home
Welcome to the CAZAIT wiki
reference
https://techblog.woowahan.com/2553/
https://velog.io/@u-nij/Git-Flow-Commit-message-Issue-%EC%9D%B4%EC%9A%A9%ED%95%B4%EC%84%9C-%ED%98%91%EC%97%85%ED%95%98%EA%B8%B0
https://ecotrust-canada.github.io/markdown-toc/
Git Flow 전략을 활용합니다. 다음 과정을 따릅니다.
1. 작업을 시작하기 전, issue를 생성합니다
2. feature branch를 생성합니다 (Ex. feature/5-first-fragment)
3. feature branch는 develop branch로부터 파생합니다.
4. 작업이 완료되었다면 add, commit, push 단계를 마칩니다
5. 3번 작업이 완료되었다면 pull request를 작성합니다
6. pull request가 작성되었을 시, 작성자 이외의 팀원과 함께 코드리뷰를 합니다
7. 코드리뷰가 끝나면 develop branch로의 merge를 수행합니다
8. 생성한 issue를 close하며 마칩니다
1. 작성된 pull request는 작성자가 merge 합니다.
2. pull request가 작성되었을 시, 하루 이내로 코드리뷰를 하도록 합니다.
3. develop branch에서 곧바로 수정하지 않습니다.
4. README 작성은 develop branch에서 수행합니다.
branch는 작업 단위 혹은 기능 단위로 생성합니다.
branch 생성은 issue를 먼저 작성하는 것으로부터 시작합니다.
issue를 작성하게 되면 생성되는 번호가 존재합니다. 이 번호와 issue에 대한 간단한 설명으로 branch 이름을 설정합니다.
양식은 다음과 같습니다.
<prefix>/<issue number>-<description>
-
main: 개발이 완료된 산출물이 저장될 공간입니다 -
develop: feature branch에서 구현된 기능들이 merge될 branch입니다 -
feature: 기능을 개발하는 branch, issue 단위로 생성하여 구현합니다 -
release: 개발이 끝나면 develop branch로부터 생성되어 최종 테스트가 진행되고 테스트가 성공되었다면 main branch로 병합합니다 -
hotfix: 버그를 수정하는 branch입니다 만일 main branch에서 버그가 발생하면 hotfix branch를 생성하여 버그를 수정하며 수정이 완료되면 develop, main branch에 merge하고 main branch에서 버전을 추가하여 배포합니다.
main
develop/v1.0.0
feature/10-sign-up
release/v1.0.0
hotfix/11-main-activty-bug
작업 시작 전 issue 생성이 선행되어야 합니다. issue는 작업 단위, 기능 단위로 생성합니다. 생성 후 issue number를 참고하여 branch name과 commit message를 작성합니다.
issue 제목은 기능의 대표적인 설명이 들어갑니다. 내용은 세부적인 내용과 작업 진행 상황을 작성합니다.
issue를 생성할 때 Github 오른편의 Assignees Label, Development를 적용합니다.
Label에는 담당자, TODO, 우선순위 등의 Label을 추가합니다.
예를 들어 대기 중인 issue는 TODO, 진행 중이라면 In Progress, 완료되었다면 Complete Label을 추가합니다.
[<Prefix>] <Description> 양식을 준수합니다.
[Feat] 회원가입 구현
[Debug] MainActivity 버그 수정
[Style] 폰트 변경
[<Prefix>] <Issue_Number> - <Description> 의 양식을 준수합니다.
-
Fix : 버그, 오류 해결
[Fix] #10 - callback error -
Add : Feat 이외의 부수적인 코드 추가, 라이브러리 추가, 새로운 View나 Activity 생성
[Add] #11 - LoginActivity[Add] #12 - CircleImageView Library -
Feat : 새로운 기능 구현
[Feat] #11 - google login -
Del : 쓸모없는 코드 삭제
[Del] #12 - unnecessary import package -
Docs : README나 WIKI 등의 문서 개정
[Docs] update readme -
Refactor : 내부 로직은 변경 하지 않고 기존의 코드를 개선하는 리팩터링 시
[Refactor] #15 - MVP architecture to MVVM -
Chore : 그 이외의 잡일/ 버전 코드 수정, 패키지 구조 변경, 파일 이동, 가독성이나 변수명, reformat 등
[Chore] #20 - delete unnecessary import package[Chore] #21 - reformat MainActivity -
Mod : xml 파일만 수정한 경우
[Mod] #30 - use constraintlayout in activity_main.xml - Test : 테스트 코드 추가
[접두어] #이슈번호 - 내용<br>
세부내용<br>
각주<br>
[FEAT] #11 - google login
- Use Firebase Auth (http://example.com/reference)
- Need refactor code
See Also : #100, #120
- Merge를 위해 Pull Request에 대한 팀원들의 Code Review를 수행합니다.
- Code Review는 변경 사항에 대해 궁금한 점, 코드 가독성(변수명, 함수명 등)에 대한 조언 등을 작성합니다.
- Code Review는 존댓말로 하며, 일방적인 시비나 비난은 금지합니다.
- Pull Request 작성자는 Code Review에 대해 성실히 답변합니다.