README.md

STACKPOT

배포링크 : https://www.stackpot.co.kr

STACKPOT-BE

Commit Convention

• [FEAT] : 새로운 기능 구현
• [MOD] : 코드 수정 및 내부 파일 수정
• [ADD] : 부수적인 코드 추가 및 라이브러리 추가, 새로운 파일 생성
• [CHORE] : 버전 코드 수정, 패키지 구조 변경, 타입 및 변수명 변경 등의 작은 작업
• [DEL] : 쓸모없는 코드나 파일 삭제
• [UI] : UI 작업
• [FIX] : 버그 및 오류 해결
• [HOTFIX] : issue나 QA에서 문의된 급한 버그 및 오류 해결
• [MERGE] : 다른 브랜치와의 MERGE
• [MOVE] : 프로젝트 내 파일이나 코드의 이동
• [RENAME] : 파일 이름 변경
• [REFACTOR] : 전면 수정
• [DOCS] : README나 WIKI 등의 문서 개정

---

📌 형식:

• [커밋 타입/#이슈번호] 커밋 내용

📌 예시

• [feat/#32] User 도메인 구현
• [feat/#32] User 필드값 annotation 추가

Branch Convention

1. 이슈 파기

   📌 형식

   [타입/#이슈번호] 이슈 내용

   📌 예시

   • [Feat/#11] User 도메인 구현
   • [Refactor/#2] User 관련 DTO 수정

2. 브랜치 파기

   📌 형식

   • 유형/#이슈번호-what

   📌 예시

   • feat/#11-login-view-ui

3. PR 올리기

   📌 형식

   • [유형] where / what

   📌 예시

   • [FEAT] 로그인 뷰 / UI 구현

   📌 PR Convention

   ### PR 타입(하나 이상의 PR 타입을 선택해주세요)
   -[] 기능 추가
   -[] 기능 삭제
   -[] 버그 수정
   -[] 의존성, 환경 변수, 빌드 관련 코드 업데이트
   
   ### 반영 브랜치
   ex) feat/login -> dev
   
   ### 변경 사항
   ex) 로그인 시, 구글 소셜 로그인 기능을 추가했습니다.
   
   ### 테스트 결과
   ex) 베이스 브랜치에 포함되기 위한 코드는 모두 정상적으로 동작해야 합니다. 결과물에 대한 스크린샷, GIF, 혹은 라이브
   

PR Convention

📌 형식

• [유형/#이슈번호] where / what

📌 예시

• [FEAT/#3] 로그인 뷰 / UI 구현

📌 PR 프로세스

1. PR 생성: 작업을 완료한 후, 변경 사항을 설명하는 PR을 생성합니다.
2. 코드 리뷰 요청: PR이 생성되면 팀원들에게 코드 리뷰를 요청합니다.
3. 코드 리뷰 진행: 리뷰어는 코드를 검토하고 피드백을 제공합니다.
4. 피드백 대응: PR 작성자는 리뷰어의 피드백을 반영하여 코드를 수정합니다.
5. 리뷰어 동의: 리뷰어는 수정된 코드를 다시 검토하고 동의합니다.
6. PR 병합: 필요한 승인 수가 충족되면, PR을 메인 브랜치에 병합합니다.

📌 PR 템플릿

### PR 타입(하나 이상의 PR 타입을 선택해주세요)
-[] 기능 추가
-[] 기능 삭제
-[] 버그 수정
-[] 의존성, 환경 변수, 빌드 관련 코드 업데이트

### 반영 브랜치
ex) feat/login -> dev

### 작업 내용
ex) 로그인 시, 구글 소셜 로그인 기능을 추가했습니다.

### 테스트 결과
ex) 베이스 브랜치에 포함되기 위한 코드는 모두 정상적으로 동작해야 합니다. 결과물에 대한 스크린샷, GIF, 혹은 라이브