📌 프로젝트 소개

• 퇴사 욕구 측정 및 이직 추천 서비스 Izikgram은 유저와 챗봇의 대화를 통해 사용자의 감정을 분석해 ‘퇴사 욕구’를 진단하여 적합한 퇴사 시기를 제안하는 서비스입니다.
• ‘퇴사 욕구’가 일정 수준 이상이 되면 유저가 설정한 조건에 맞는 채용 공고를 제안하여 유저의 원활한 퇴사를 돕습니다.
• 또한, 퇴사를 원하는 유저들의 커뮤니티 제공하여 자유롭게 이야기하고, 직장에서의 스트레스를 풀어 원활한 직장 생활을 영위할 수 있도록 합니다.
  
  

🧑‍💻 팀 소개

강승민	🐹 김태현	신동억	🥔 임하형	차기석
SeungMin2055	kokiyo1030	shindongeok	hahyeong	chakisuk

📌 Coding Convention

함수에 대한 주석

• 백엔드에서 공통적으로 사용하는 함수의 경우, 모듈화를 통해 하나의 파일로 관리한다.
• 하나의 파일의 시작 부분에 주석으로 상세 내용을 작성한다.

변수명

• Camel Case로 작성합니다.
• 의미를 파악하기 쉬운 변수명을 사용한다.
• 웬만하면 약어는 지양하도록 한다.
• boolean의 경으 'is', 'has', 'can'과 같은 접두어를 사용한다.
• 숫자의 경우 'max', 'min', 'total'과 같은 접두어로 의미를 표기한다.
• 함수일 경우 동사와 명사를 사용하여 actionResource의 형식(동사+명사)을 따르도록 한다.
• 상수는 대문자로 표기한다.

Code

• 중괄호로 붂이지 않은 블록문은 금지한다.
• 들여쓰기의 크기는 4-spaces로 한다.

📌 Git Convention

🔹Commit Convention

• ✅ [CHORE] : 동작에 영향 없는 코드 or 변경 없는 변경사항(주석 추가 등)
• ✨ [FEAT] : 새로운 기능 구현
• ➕ [ADD] : Feat 이외의 부수적인 코드 추가, 라이브러리 추가, 새로운 파일 생성
• 🔨 [FIX] : 버그, 오류 해결
• ⚰️ [DEL] : 쓸모없는 코드 삭제
• 📝 [DOCS] : README나 WIKI 등의 문서 수정
• ✏️ [CORRECT] : 주로 문법의 오류나 타입의 변경, 이름 변경시
• ⏪️ [RENAME] : 파일 이름 변경시
• ♻️ [REFACTOR] : 전면 수정
• 🔀 [MERGE]: 다른 브랜치와 병합 ex) git commit -m "#{이슈번호} [FEAT] 회원가입 기능 완료"

🔹Branch Convention

• [develop] : 최종 배포
• [feat] : 기능 추가
• [fix] : 에러 수정, 버그 수정
• [docs] : README, 문서
• [refactor] : 코드 리펙토링 (기능 변경 없이 코드만 수정할 때)
• [modify] : 코드 수정 (기능의 변화가 있을 때)
• [chore] : gradle 세팅, 위의 것 이외에 거의 모든 것 ex) feat/#{이슈번호}

🔹Branch Strategy

💡 Git Flow

• 기본적으로 Git Flow 전략을 이용한다.
• Fork한 후 나의 repository에서 작업하고 구현 후 원본 repository에 pr을 날린다.
• 작업 시작 시 선행되어야 할 작업은 다음과 같다.

  1. Issue를 생성한다.
  2. feature Branch를 생성한다.
  3. Add - Commit - Push - Pull Request 의 과정을 거친다.
  4. Pull Request가 작성되면 작성자 이외의 다른 팀원이 Code Review를 한다.
  5. Code Review가 완료되면 Pull Request 작성자가 develop Branch로 merge 한다.
  6. merge된 작업이 있을 경우, 다른 브랜치에서 작업을 진행 중이던 개발자는 본인의 브랜치로 merge된 작업을 Pull 받아온다.
  7. 종료된 Issue와 Pull Request의 Label과 Project를 관리한다.
  

• main, develop, feature 3가지 branch 를 기본으로 합니다.
• main → develop → feature. feature 브랜치는 feat/기능명으로 사용합니다.
• 이슈를 사용하는 경우 브랜치명을 feature/[issue num]-[feature name]로 합니다.

🔹Issue Convention

• [FEAT] : 기능 추가
• [FIX] : 에러 수정, 버그 수정
• [DOCS] : README, 문서
• [REFACTOR] : 코드 리펙토링 (기능 변경 없이 코드만 수정할 때)
• [MODIFY] : 코드 수정 (기능의 변화가 있을 때)
• [CHORE] : gradle 세팅, 위의 것 이외에 거의 모든 것 ex) [feat] user api 구현