GitHub Convention

➡️ Github Convention

Spark_Android_Github Convention 을 토대로 작성하였습니다.

• 1개의 feature 단위로 브랜치 생성
• 1개의 feature 단위로 issue 생성
• 1개의 issue 내에 세부작업마다 commit 을 날려
• 1개의 feature 끝나면 pull request 열어 ⇒ 머지 하면 ⇒ 해당 issue close

🔥Issue Convention🔥

## 화면 이름

## 기능 설명

## 필요 태스크
- [ ] Task1
- [ ] Task2

• 한글로 쓰기
• 명령조 사용하기 (수정(o)수정한다(x))
• issue 제목
  • [화면명] 이슈명
• github label
  • commit prefix 과 동일하게 만들 예정
  • 팀원 이름 추가
  • pull request 라벨 추가 (풀리퀘할 때 달기)

🔥Commit Convention🔥

commit message convention

• #{issue_number} [prefix] 작엽명

• ex) #1 [feat] 로그인 버튼 클릭 이벤트 처리

  (이슈를 생성하면 이슈 번호가 부여됨. 커밋할 때 이슈단으로 커밋하고 이슈번호를 커밋메시지에 #과 함께 적어주면 어떤 이슈를 처리하는 작업이었는지 조회하기 편함.)

• commit message 마지막에 마침표(.) 찍지 않기

  • commit prefix
    • [feat] : 기능 추가, kotlin 작업
    • [layout] : xml 작업
    • [fix] : 에러 수정, 버그 수정
    • [docs] : README, 문서
    • [refactor] : 코드 리펙토링 (기능 변경 없이 코드만 수정할 때)
    • [modify] : 코드 수정 (기능의 변화가 있을 때)
    • [chore] : gradle 세팅, 위의 것 이외에 거의 모든 것

🔥PR Convention🔥

## 관련 이슈번호
		#123,#234
## 화면 이름
		#123 관련 화면이름 , #234 관련 화면이름
## 완료 태스크
	#123
- [ ] Task1
- [ ] Task2
	#234
- [ ] Task1
- [ ] Task2

• 한글로 쓰기

• 명령조 사용하기 (수정(o)수정한다(x)

• 제목: issue 번호 나열 화면 + 브랜치 이름

  ex)#111,#84 feature/build-gradle-script-write

• 내용: 템플릿 형식을 따르며 풀리퀘에서 해결한 이슈들의 이슈번호,화면이름, 완료태스크를 이슈별로 정리해서 작성한다.