-
Notifications
You must be signed in to change notification settings - Fork 0
Home
-
https://jinger.tistory.com/entry/%EA%B9%83%ED%97%88%EB%B8%8C-Wiki
-
본인이 문서화 할 문서를 New Page를 통해서 작성한다.
-
그 다음, 커스텀 바 편집을 통해서 인덱싱을 URL 참조를 통해 직접 정리한다.(Link를 통해 직접 만든 Wiki 페이지 URL을 걸어줘야함)
-
Github Clone으로 로컬에 연동
-
Epic - Story/Task - SubTask 단위로 나눔
-
Jira Issue를 feature 브랜치 대행으로 Jira Issue로 만들어서 작업, 트랙킹 가능 + Commit 메시지 & PR내의 연동 가능
-
평소 Github 작업대로 진행하면서 Commit 메시지 & PR에서 Jira Issue 기반으로 작업을 진행하면 사전에 정한 Issue대로 트랙킹해서 코드를 볼 수 있게 작업 가능
Jira -> 작업 -> commit(Jira에 적은거 기반으로 메시지 수정) -> PR(설명할 필요 있는거 메시지에 적기)
-
Linting 적용 시 아래 글과 글 안 레퍼런스 참고, 직접 뭐가 있는지 체크해서 커스텀하게 하거나 제너럴 한 부분만 체크하게 할 수 있음 or 자동화 툴을 달아서 Code Smell을 Sonar Qube 등을 활용하여 정적 분석하는 방법도 있긴함
- 카멜 표기법 사용
- 함수 이름은 일반적으로 동사
- 변수 이름은 일반적으로 명사
- Firebase에서 가져온 Data를 저장하는 인스턴스는 접미사로 Data를 붙인다.
(what)_(where)
- what : activity, fragment, view, item, etc..
- where : main, setting, etc...
- acitivty_main : MainActivity의 뷰
- framgent_detail : DetailFragment의 뷰
- dialog_main : MainActivity에서 사용될 다이얼로그
- item_location : LocationRecyclerview에 들어갈 아이템 뷰
(what)_(description) what에 사용하는 UI 컴포넌트는 줄임말을 사용한다.
- what : tv(textview), btn(button), etc...
- description : result, name, etc...
- tv_result : MainActivity의 결과값을 보여주는 textview
(where)_(what)_(description)
- where : main, setting, etc..
- what : tv, btn, etc..
- description : title, content, etc...
- main_title : MainActivity의 title에 사용
- all_content : 모든 뷰에서 content에 사용
(what)_(description)_(size)_(color)
- what: background, icon, etc..
- description : info, alert, etc...
- size : 24, 36, etc...
- color: black, white, etc...
- main_info_24 : MainActivity에서 사용될 24dp 크기의 info 이미지
- all_alert_36_black : 모든 뷰에서 사용될 36dp 크기의 alert 이미지의 black
스타일에서 크기와 공백같이 디자인을 보면서 작업해야하는 것들은 아이템에서 제외한다. ex) android:layout_marginTop="16dp"
(what)_(description)_(etc)
- what: tv, et, etc..
- description: background, logo, etc...
- etc: 색, 위치 등 -> top, bottom, left, right, orange, black, etc..
- main_background_black : MainActivity에서 사용될 검정색 배경의 스타일
- setting_logo_top : SettingActivty에서 위쪽에 위치한 로고의 스타일
Material 혹은 디자인 시스템을 기반으로 네이밍
(color)_(brightness)
- color: black, white, etc..
- brightness: 10, 20, 200, 300, etc..
Tag
- Design, Feature, Refactor