Github Rules

브랜치 전략 : Git-flow

브랜치 이름

feature/name 으로 이름을 명시한다
인해 : feature/action-add
성준 : feature/likes
경연 : feature/goods
혜련 : feature/main-page
현주 : feature/singup
메인 브랜치
항상 유지되는 브랜치
main: 제품으로 출시될 수 있는 브랜치
dev 브랜치
각 기능을 병합하는 브랜치
보조 브랜치
feature: 기능을 개발하는 브랜치

개발 프로세스

 2. 커밋 컨벤션

커밋 메시지 양식

타입: 제목
ex_ feat: 월과 일의 숫자를 두 자리로 맞춰주는 기능

<타입> 참고 사항

feat : 기능 (새로운 기능)
init : 초기 생성 (초기 세팅, git 생성자)
add : 파일이나 코드 추가 했을 때 ex. add: style.css
fix : 버그 (버그 수정)
del : 파일 또는 폴더 삭제
refactor : 코드를 리펙토링해서 개선했을 경우
design: css 작업 등 디자인에 관련된 코드 변경
docs : 문서 (문서 추가, 수정, 삭제) ex. README.md 수정
test : 테스트 (테스트 코드 추가, 수정, 삭제: 비즈니스 로직에 변경 없음)
chore : 설정 관련 변경 사항 (빌드 스크립트 수정, package.json 등)

<제목> 참고 사항

타입은 영어로 작성하고 제목과 본문은 한글로 작성한다.
제목 끝에 마침표(.) 금지
제목과 본문을 한 줄 띄워 분리하기(shift+enter)
본문은 "어떻게" 보다 "무엇을", "왜"를 설명한다.
본문에 여러 줄의 메시지를 작성할 땐 글머리 기호 "-"로 구분
관련된 이슈 번호는 괄호와 함께 제목 맨 뒤에 추가한다. ex_(#1)

예시

type: 제목 커밋 내용 요약 (한 일) ex) 변수명 수정 - Intent (의도가 보이면 생략해도 됨) 어떤 의도로 이 코드를 작성하였다 ex) 기존의 변수명은 ~ 의미로 읽혔어서, ~의미에 가깝도록 변수명을 수정했다.
JavaScript
복사
fix: Cache workflow 저장 조건 변경 - Intent 기존에 frontend, backend의 package-lock.json이 모두 변경되지 않았을 때에만 cache되는 것에서 frontend의 package-lock.json이 변경되지 않으면 캐싱하는 것으로 수정
JavaScript
복사

 3. 이슈 템플릿

--- name: Custom issue template about: 해당이슈 템플릿을 사용하여 이슈를 생성해주세요. title: "[타입] - 설명" labels: '' assignees: '' --- 📕 Issue Feature 전체적인 작업사항을 입력해주세요 🧾Todo - [ ] 작업사항 - [ ] 작업사항
JavaScript
복사

 4. PR 템플릿

## 📌 관련 이슈 <!-- 관련있는 이슈 번호(#000)을 적어주세요. 해당 pull request merge와 함께 이슈를 닫으려면 closed #Issue_number를 적어주세요 --> ## Task TODOLIST <!-- 자신이 한 작업을 간단하게 TODO로 표현해주세요! --> - [ ] 이걸 계속 복사해서 사용해주세요! ## ✨ 개발 내용 <!-- 개발에 대한 내용을 적어주세요 --> ``` ``` ## TroubleShooting <!-- TroubleShooting이 있었다면 이야기 해주세요! --> ``` ``` ## 📸 스크린샷(선택) ``` |기능|스크린샷| <!-- 기능을 gif로 만들어서 올려주세요 --> [GIF]<img src = "" width="250">| ``` ## 📚 레퍼런스 (또는 새로 알게 된 내용) 혹은 궁금한 사항들 <!-- 참고할 사항이 있다면 적어주세요 -->
JavaScript
복사