Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs : 프로젝트 적용 사항 #1

Open
ss99x2002 opened this issue Sep 3, 2024 · 0 comments
Open

docs : 프로젝트 적용 사항 #1

ss99x2002 opened this issue Sep 3, 2024 · 0 comments
Assignees
Labels
📝docs Improvements or additions to documentation

Comments

@ss99x2002
Copy link
Owner

ss99x2002 commented Sep 3, 2024

Issue 🛠

프로젝트에 적용하는 사항들을 기록합니다.

To-do

[Compose UI 개발]

  • Compose 개발할 때 compose의 장점을 극대화 하기 위한 규칙들을 살펴 볼 수 있다.
    사용 규칙
  1. UI 상태 관리 지점을 일원화하기
  2. 상태 호이스팅(state hoisting)을 사용해 컴포저블을 스테이트리스(stateless)하게 만들기
  3. 만든 컴포저블은 미리 보기(preview) 기능을 사용해 상태별로 미리 보기 만들기

[컴포넌트 단위 UI 개발]

  • 장점 : 유지보수의 용이성, 생산성 향상 (동일한 코드 생성하지 않아도 됨) => 재사용성 증가

[Compose 레이아웃 그리기]

[ktlint 적용]

  • 프로젝트 내에 ./gradlew 터미널 실행해서 ktlint 검사 가능
  • github action CI를 통해서 pr 과정에 ktlint 검사를 한번 더 하도록 진행
  • 일관성 유지, 리뷰어의 코드 스타일 검수 줄일 수 있음, 자동 피드백으로 신속하게 확인 가능
  • add hook 을 통해서 커밋 이전에 ktlint 검사 강제 주입 가능
  • 관련링크1
  • compose는 lower case 적용 안한다는 것을 .editorconfig에 명시해줘야 함
  • 코드 스타일 검사 후 틀린 부분을 자동으로 수정합니다. $ ./gradlew ktlintFormat

[AI 코드 리뷰어 등록]

@ss99x2002 ss99x2002 self-assigned this Sep 3, 2024
ss99x2002 added a commit that referenced this issue Sep 5, 2024
Setting/#1 : 프로젝트 초기 세팅
@ss99x2002 ss99x2002 added the 📝docs Improvements or additions to documentation label Oct 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📝docs Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant