API 개발

• API 개발 후 문서화를 위해 Swagger 주석을 작성합니다.

Commit Convention

• 다른 API를 참고하여 기존 주석을 복사 후 수정해서 사용하면 됩니다.
• 아래 내용은 **https://www.conventionalcommits.org/ko/v1.0.0/** 에 정리되어 있습니다.
• 커밋메세지는 타입: 내용 형태로 작성합니다.
  • 예) feat: 시간표 페이지 구현
  • ex) feat: implement TimetablePage
• 타입에는 이런 것들이 들어갈 수 있습니다.
  • feat - 기능 추가 또는 개발
  • fix - 기존 코드 및 버그 수정
  • docs - 문서(Markdown 등) 수정
  • style - 포멧(ESLint) 수정
  • refactor - 코드 리팩토링
  • test - 테스트 코드 작성 또는 수정
  • chore - 실제 코드와 관련 없는 파일 수정 (설정, 스크립트, 환경변수 등)
• 커밋메세지는 한글, 영어 모두 쓸 수 있습니다.
• 무엇을 보다는 왜 중심의 커밋메세지 작성을 권장합니다.
  • 예) fix: 다음달 학사일정을 가져오기 위해 로직 개선
• 커밋메세지에 모든 내용을 설명할 수 없으면 Body에 자세하게 적습니다.

Pull Request

• PR 양식은 꼭 지켜야합니다.
• 무엇이 추가되고 변경됐는지 알 수 있어야합니다.
• 코드리뷰를 권장합니다.

Branch Convention

• 브랜치 이름에는 한글을 사용하지 않습니다.
• main 브랜치는 배포가 되거나 배포 대기 중인 브랜치입니다.
• develop 브랜치는 현재 개발 중인 브랜치입니다. (기본 브랜치)
  • develop 브랜치에서 분기하여 개발합니다.
  • ex) feature/timetable , fix/calendar , refactor/database
  • feature 은 feat 으로 줄일 수 있습니다.

Code Convention