Code Convention

Code Convention

• Trailing Comma 적용합니다
• 마지막 줄 개행 적용합니다
• Composable 함수에서 modifier 는 첫번째 paramter 로 선언합니다
• 기타 Convention 은 ktlint 정책을 따릅니다
• Composable 함수의 parameter 정의 순서는 다음과 같습니다.
  1. modifier
  2. 필수 parameter
  3. 필수 lambda
  4. default 값이 있는 parameter
  5. default 값이 있는 lambda

Gitmoji

• feature ( ✨ )( sparkles ) : 기능 개발 내용
• fix ( 🐛 )( bug ) : API 스펙 변경 등으로 코드수정이 필요할 때, 오류 발생을 고칠 때
• refactory ( ♻️ )( recycle ) : architecture 변경작업, ktlint 등의 컨벤션검사로 유발된 수정사항
• resource ( 💄 )( lipstick ) : 글자, 색상, style 등과 관련된 리소스 파일들 추가할 때
• gradle ( ➕ / ➖ )( heavy_plus_sign / heavy_minus_sign ) : gradle 관련된 의존성 추가 및 제거
• move ( 🚚 )( truck ) : 파일 경로 이동
• delete ( 🔥 )( fire ) : 코드/리소스 등이 더 이상 필요없어서 제거해야 할 때
• readme ( 📝 )( memo ) : readme 파일 수정 시
• comment ( 💡 )( bulb ) : 주석만 추가할 때
• test code ( ✅ )( white_check_mark ) : 테스트 코드 관련 코드를 추가할 때
• chore ( 👷 )( construction_worker ) : 기타 등등의 자질구레한 코드 일 때

Others

• PR 올리기 전에 ktlint 체크하고 올려주세요 (".\gradlew ktlintCheck")
• 2명이 approve 해야 merge 가능합니다
• 코드리뷰 말투는 편하게 합니다 (반말모드 ON)
• 금지어 : (욕설), (화), "ㅡㅡ", "?" ...
• "Issues" 에 해야할 작업을 관리합니다