스터디 규칙

[ohhonggi]

Flow

이슈 발행 ➡ 이슈에서 브랜치 파서 Sprint 진행 ➡ 커밋 시 이슈 넘버 #0 description에 작성 ➡ pull request를 통해 해당 주차에 진행한 sprint upload ➡ 코드리뷰 ➡ Merge ➡ branch close

Branch

• 브랜치는 main(메인용 branch), study(매 주 sprint branch) 2개로 운영
• study/자신 이름/n (n은 몇 주차인지를 의미) branch 만들어서 작업 후 pr 날리기 ex) study/honggi/1
• main에 merge되기 전에는 최소 1승인 받기(code review 없어도 체크하기, 크로스 체크 형식)

Structure

1. 자신 이름 폴더 생성
2. 폴더 내부에 blog와 code 폴더로 나누기
   • 그 주차에 문제를 풀이한 경우, code 폴더 안에 문제 해결 code 올리기
   • 그 주차에 blog를 정리한 경우, blog 폴더 안에 해당하는 page 올리기
3. 각 주차에 진행한 내용 구분해서 적용하기

ex)

.
├── honggi                   
│   ├── code
│   │     ├── **
│   └── blog
│         └─ **
├── docs                    # templates folders (alternatively `doc`)
├── .gitignore
└── README.md

Commit

type	커밋 종류
feat	새로운 기능에 대한 커밋
fix	버그 수정에 대한 커밋
build	빌드 관련 파일 수정에 대한 커밋
chore	그 외 자잘한 수정에 대한 커밋
cicd	CICD 관련 설정 수정에 대한 커밋
docs	문서 수정에 대한 커밋
style	코드 스타일 혹은 포맷 등에 관한 커밋
refactor	코드 리팩토링에 대한 커밋
test	테스트 코드 수정에 대한 커밋

📖 Reference

• Pull request template
• Commit guidelines
• Markdown directory structure