22.06.14 회의록(브랜치 전략, code 컨벤션, commit 메시지)

code 컨벤션 → 구글 자바 코드 스타일 따라가기

참고

• 구글 자바 코드 스타일

• [intellij] google code 포매터 적용

• Reformatting code before you commit it

 

코딩 컨벤션 가이드 모음

코딩 컨벤션이란? 일종의 코딩 스타일 규약으로 모든 구성원들이 읽고, 관리하기 쉬운 코드를 작성하는 것...

https://blog.naver.com/PostView.naver?blogId=rinjyu&logNo=222458111066&parentCategoryNo=&categoryNo=8&viewDate=&isShowPopularPosts=true&from=search

캠퍼스 핵데이 Java 코딩 컨벤션

약어가 클래스명에서 대문자로 들어가면 단어 간의 구분을 인지하기에 불리하다. 약어가 연속된 경우 더욱 가독성을 해친다. 예를 들면 XMLRPCHTTPAPIURL과 같은 경우이다. 그래서 기본 정책으로는 약어의 중간단어를 소문자로 표기하고 프로젝트별로 모두 대문자로 표기할 약어의 목록을 명시하는 방식이 가독성을 높이고 규칙을 단순화하는데 유리하다. 즉 프로젝트 내에서 정의한 단어 목록이 없다면 'XmlRpcHttpApiUrl'과 같이 쓴다.

https://naver.github.io/hackday-conventions-java/

commit message

Git - 커밋 메시지 컨벤션

02_commit_message_rule.md 커밋 메시지를 작성할 때는 원칙을 정하고 일관성 있게 작성해야 한다. 아래는 유다시티의 커밋 메시지 스타일 가이드를 참조한 내용이다. 기본적으로 커밋 메시지는 아래와 같이 제목/본문/꼬리말로 구성한다.

https://doublesprogramming.tistory.com/256

commit-messages-guide/README_ko-KR.md at master · RomuloOliveira/commit-messages-guide

커밋 메시지의 중요성을 이해하고 어떻게 하면 잘 작성할 수 있는지에 대해 설명하는 안내서입니다. 커밋 메시지가 무엇이며, 왜 잘 작성하는 것이 중요한지 알아보고 좋은 커밋 히스토리를 유지하고 싶을 때 적용할 수 있는 최고의 접근법과 몇 가지 유용한 팁을 배워봅시다. 간단히 말해서, "커밋 (commit)" 은 로컬 저장소에 쓰여지는 로컬 파일들의 단편본입니다.

https://github.com/RomuloOliveira/commit-messages-guide/blob/master/README_ko-KR.md

좋은 git 커밋 메시지를 작성하기 위한 8가지 약속

본 글은 Chris Beams의 How to Write a Git Commit Message 블로그 내용을 토대로 편집하고 내용을 추가한 것입니다. 왜 커밋 메시지를 잘 쓰기 위해 노력해야 할까요? 이유는 서로 다를 수 있지만, 잘 쓰인 커밋 메시지가 더 유익하다는 사실에는 많은 프로그래머들이 공감할 것으로 생각합니다. 좋은 커밋 메시지의 목표 중 대표적인 3가지를 꼽아보았습니다.

https://djkeh.github.io/articles/How-to-write-a-git-commit-message-kor/

GitHub 커밋 메세지에 JIRA 이슈번호 자동으로 넣어주기

항상 앞에 이슈번호를 넣어주어야 하는 귀찮음을 자동으로 넣어주도록 처리하는 방법에 대해 공유합니다. Jira를 사용하는 회사에서는 대부분 커밋 메세지 앞에 이슈번호를 붙여서 사용합니다. HDA-1089 어쩌구 저쩌구 , HDA-1096 블라블라 Branch의 이름과 Commit의 이름은 항상 Jira의 이슈번호로 시작 합니다. 이러한 이슈번호 관리를 통해서 어떤 코드에 대해서 History를 확인했을때 해당 코드가 어떤 피쳐와 이슈로 인해서 수정되었는지 직접 해당 티켓에 가서 확인할 수 있습니다.

https://medium.com/prnd/github-%EC%BB%A4%EB%B0%8B-%EB%A9%94%EC%84%B8%EC%A7%80%EC%97%90-jira-%EC%9D%B4%EC%8A%88%EB%B2%88%ED%98%B8-%EC%9E%90%EB%8F%99%EC%9C%BC%EB%A1%9C-%EB%84%A3%EC%96%B4%EC%A3%BC%EA%B8%B0-779048784037

commit message prefix

• feat: 새로운 기능 추가

• fix: 버그 수정

• docs: 문서 수정

• style: 코드 스타일 변경 (코드 포매팅, 세미콜론 누락 등)

• test: 테스트 코드, 리팩토링 (Test Code)

• refactor: 리팩토링 (Production Code)

• build: 빌드 파일 수정

• chore: 자잘한 수정이나 빌드 업데이트

• rename: 파일 혹은 폴더명을 수정만 한 경우

• remove: 파일을 삭제만 한 경우

 

• 커밋메시지에 지라 이슈번호 넣기 (자동 pre commit)

• 예) feat : 기능 추가 [GD-13]
• 컨텐츠는 안에 자유롭게

• Java Version 정하기 → jdk 16
• 상위 태스크(여기 기준으로 리뷰어 정하기)
• 하위 태스크 1
• 하위 태스크 2

• 데일리 스크럼 별로 코딩 스타일(?) 점차점차 맞춰가기
• eg) dto 이용방법
• eg) 엔티티 생성자
• …

• AirCnC JIRA 프로젝트 생성 - 완료

• 프로젝트명 - AirCnC
 

회원

• 회원 CRUD

• 회원 가입(CREATE)
• 그냥 가입(JWT)
• Oauth2.0

게스트

• 숙소 조회
• 전체 페이지(페이지네이션) - 무한 스크롤
• 숙소 필터링 조회 - 옵션 너무 많음..
• 지도 API 를 통한 조회
• 숙소 편의 시설

• 숙소 예약 기능
• 예약 여부 확인(날짜 겹치면 안됨)

• 숙소 찜하기

• 호스트로 등록

• 숙소 좋아요

• 숙소 후기 등록

호스트

• 숙소 등록

• 호스트가 회원이 예약 신청보낸 것에 대해 수락하는 기능