[Guideline for Conribution]

경북대학교 컴퓨터학부 Committee Of System Library(시도위) 의 프로젝트에 기여해주셔서 감사합니다.

아래 사항을 참고해주세요.

• 컨트리뷰션 가이드
• PR 가이드
• commit 가이드
• 컨벤션 가이드

컨트리뷰션 가이드

다양한 방식으로 기여할 수 있습니다

언제든지 편하게 issue에 의견을 올려주세요!
의견을 공유하는 것도 기여입니다.
issue에서 다양한 의견을 공유하고, 추가되거나 수정되어야하는 기능을 PR로 기여하실 수도 있습니다

노션 페이지에서 현황을 파악할 수 있습니다

PR 가이드

• 컨트리뷰터가 아닌 경우 fork 후 PR을 요청해주세요

• PR 형식은 아래와 같습니다

<예시>

---

Description

설명

Changes

변경사항

Test Checklist

테스트 항목

---

branch 전략

기본적으로 master-develop branch가 존재하며 PR merge를 요청하는 branch는 develop입니다
dev에서 분기한 branch의 이름은 feature/이슈넘버 or xxx, fix/이슈넘버 or xxx , refactor/xxx 로 지정해주세요

• PR을 Merge 하기 위해선 반드시 1명 이상의 Approve가 필요합니다.
• PR은 Sqush and merge 옵션으로 merge합니다
• master <- develop으로 Merge 시에는 Create a merge commit 옵션으로 Merge합니다
• PR 제목은 아래와 같이 지어주세요. (issue가 없다면 생략해주세요)

  (#issue-number) 내용 요약

• master <- develop PR 생성 시 develop에 merge된 pr 목록을 내용에 적어주세요.
• master, develop branch에는 commit할 수 없습니다.
• master는 prod에 배포하는 브랜치이기 떄문에 주의해주세요.

코드 리뷰 규칙

코드 리뷰 참고 글을 읽어주세요

• 왜 개선이 필요한지 이유를 충분한 설명해 주세요.
• 답을 알려주기보다는 스스로 고민하고 개선 방법을 선택할 수 있게 해주세요.
• 코드를 클린 하게 유지하고, 일관되게 구현하도록 안내해 주세요.
• 리뷰 과정이 숙제검사가 아닌 학습과정으로 느낄 수 있게 리뷰해 주세요.
• 리뷰를 위한 리뷰를 하지 마세요. 피드백 할 게 없으면 칭찬해 주세요.

리뷰어의 책임이 50%라는 마음으로 리뷰를 부탁드립니다

commit 가이드

Commit 양식은 해당 사이트를 참고해주세요

<type>[optional scope]: <description>

[optional body]

[optional footer(s)]

• 위의 양식을 준수하며 제목과 본문은 한글로 작성해주세요
  
• type은 영어로 작성해주세요

예시 )

feat: 시도위 쿠폰 발행 기능 추가

//본문은 한줄 띄워주세요
xxx 쿠폰 발행을 만족하기 위해....

• 커밋 로그를 보고 흐름을 이해할 수 있도록 작성 부탁드려요
• 명확한 제목과 자세한 본문 작성을 부탁드려요

컨벤션 가이드

구글 코딩 컨벤션을 따라주세요

• JAVA: https://github.com/google/styleguide/blob/gh-pages/intellij-java-google-style.xml
• Python: https://peps.python.org/pep-0008/
• Other: ...
  
  Intellij의 경우 컨벤션 auto-setting 방법이 존재하며 세팅을 해놓는 것을 추천드립니다
  클린 코드를 함께 고민보아요!