Skip to content

docs: README를 현재 코드 상태와 동기화 - #1

Open
jiungbaek wants to merge 1 commit into
mainfrom
docs/readme-sync
Open

docs: README를 현재 코드 상태와 동기화#1
jiungbaek wants to merge 1 commit into
mainfrom
docs/readme-sync

Conversation

@jiungbaek

Copy link
Copy Markdown
Owner

요약

README.md가 현재 코드/설정과 어긋난 부분을 점검하고 수정했습니다.

  • shadcn/ui 스타일명 오타: components.jsonstyle 값은 radix-mira인데 README에는 radix-maia로 적혀 있었습니다 (63f2380 커밋에서 값이 바뀐 뒤 README가 갱신되지 않음). → 수정 완료.
  • 테스트 스크립트 누락: package.jsontest(vitest run), test:watch(vitest) 스크립트가 있고 Vitest + React Testing Library 환경이 구축되어 있는데(a232186 커밋), README의 "자주 쓰는 스크립트" 목록에는 빠져 있었습니다. → 추가 완료.

확인했으나 수정하지 않은 항목 (판단 필요)

  • "챕터별 시작 브랜치" 섹션: README는 git checkout ch02-03 예시로 레슨별 시작 브랜치가 제공된다고 안내하지만, 현재 원격 저장소(origin)에는 main 브랜치만 존재하고 ch02-03 등 챕터 브랜치는 하나도 없습니다 (git ls-remote --heads origin 확인). 그대로 따라 하면 체크아웃 명령이 실패합니다. 강의 진행에 따라 브랜치를 추후 추가할 계획인지, 아니면 안내 자체가 stale한 것인지 저장소 관리자 판단이 필요해 이번 PR에서는 건드리지 않았습니다.
  • bun 버전(1.3.6) 명시는 packageManager 필드나 .bun-version 등 고정 기준이 없어 임의로 판단하기 어려워 그대로 두었습니다.

Test plan

  • components.jsonstyle 필드와 README 문구 대조
  • package.json scripts와 README 스크립트 목록 대조
  • git log -p -- components.json으로 스타일명 변경 이력 확인
  • git ls-remote --heads origin으로 챕터 브랜치 존재 여부 확인

🤖 자동 스케줄 작업(readme 점검)으로 생성됨

- shadcn/ui 스타일을 components.json 기준(radix-mira)으로 수정 (radix-maia는 오타)
- Vitest 테스트 스크립트(bun run test, bun run test:watch) 안내 추가
@vercel

vercel Bot commented Jul 8, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
todo-tutorial Ready Ready Preview, Comment Jul 8, 2026 8:20am

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants