convention
폴더 이름은 소문자로 된 한 개의 단어
그 외 util은 util 폴더에
ex) ./app/src/main/ui
./app/src/main/network
./app/src/main/data
-
적용 사례
UpperCamelCase
ex) SignInActivity, SignInFragment, ImageUploaderService,ChangePasswordDialog
- 약어 사전에 있는 단어는 되도록 약어를 사용합니다.
ex) UserInterface -> UI or Ui
snake_case
-
Example
lowerCamelCase
-
함수 이름은 "동사"로 시작하는 "동사구" 형태를 사용하되, 동사 원형만을 사용
ex) showList, updateContacts
-
자주 사용하는 동사는 용법에 맞게 사용
show: Invisible한 것을 Visible하게 바꾸는 동작
check: 어떤 것을 확인한 후 boolean 또는 값으로 반환하는 동작
is: 어떤 것인지 확인한 후 boolean으로 반환하는 동작
has: 어떤것을가지고 있는 확인 후 boolean으로 반환하는 동작
- 한 단어 내에서는 대소문자 변경 없이 사용합니다.
ex) InVisible -> Invisible, UnSelect -> Unselect
class MainActivity : AppCompatActivity() {
/*
*/
...
// 로그인
private fun signIn(){}
//
// 로그인 -> 회원가입 이동
private fun signInToSignUp(){}
// 상단 시스템바를 투명하게
private fun initTransparentSystemBar() {}
}(default)Reformatter
브랜치 전략
-
image
- 커밋 메시지 작성법은 AngularJS Git Commit Message Conventions 을 기본으로 한다.
- 작성시 참고하면 좋은 글
- 커밋 메시지 양식
<type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>-
<subject>의 예시: MainActivity를 만듬)feat(MainActivity.kt): MainActivity를 만듬.
-
커밋은 파일 단위
Example
fix: OAuth 통신 버그 수정
OAuth 연결 시 token 만료 문제 해결
viewModel에서 postValue 대신 setValue를 사용
Resolves: #123
See also: #456, #789선택적 리뷰를 진행한다
리뷰가 필요한 코드는 PR을 날린 후 Reviewer를 태그한다
- Pull Request (v) 작업한 브랜치에서 커밋 > 푸시 > 작업한 브랜치 > 마스터 풀리퀘 생성 → 풀리퀘가 올라가고 머지할지말지 확인 후 머지
- PR Title ⇒ 작업한 내용 한문장 요약
- PR Contents ⇒ 작업 내용 설명
참고