Skip to content

[Docs] 리드미 수정#123

Open
yeonjin719 wants to merge 2 commits into
developfrom
docs/#122
Open

[Docs] 리드미 수정#123
yeonjin719 wants to merge 2 commits into
developfrom
docs/#122

Conversation

@yeonjin719

Copy link
Copy Markdown
Member

🔗 관련 이슈


🧩 작업 요약 (TL;DR)

이 PR에서 무엇을 왜 했는지 한 줄로 요약해주세요.
리드미 수정 및 사진 추가


🔄 변경 유형

해당되는 항목에 체크해주세요.

  • ✨ Feature
  • 🐞 Bug Fix
  • 🔨 Refactor (기능 변화 없음)
  • 🎨 UI / UX
  • ⚙️ Setting / Infra
  • 🧪 Test
  • 📄 Docs

📌 주요 변경 사항

리뷰어가 집중해서 봐야 할 포인트

  • 리드미 봐주세용 추가하고 싶은 거 있으면 말씀해주세요!

🖼️ 스크린샷 / 영상 (선택)

UI 변경이 있다면 꼭 첨부해주세요.

Before After

🧠 리뷰 요청 포인트

리뷰어에게 특히 봐줬으면 하는 부분

  • 로직 설계
  • 상태 관리 방식
  • 네이밍
  • 성능 / 렌더링
  • 기타: ___

⚠️ 체크리스트 (PR 올리기 전)

  • 로컬에서 정상 동작 확인
  • 기존 기능에 영향 없음
  • 불필요한 console.log 제거
  • 린트 / 타입 에러 없음
  • 관련 이슈 연결 완료

🚧 미완 / 후속 작업

이 PR에서 다루지 않은 내용이나 추후 작업

  • N/A

💬 기타 참고 사항

리뷰어가 알면 좋은 맥락, 트레이드오프, 고민 지점

@copilot 이 PR을 아래 기준으로 검토해주세요:

.github/instructions/capstone.instructions.md 파일을 지침으로 삼으세요.
폴더/파일 위치가 프로젝트 구조 규칙과 일치하는지
컴포넌트가 단일 책임 원칙(SRP)을 지키는지
import 방향이 올바른지 (shared → features 역방향 없음)
명명/케이스가 일관적인지 (PascalCase vs camelCase)
배럴(index.ts) 사용이 현 패턴을 따르는지
응답은 한국어로, 발견된 위반 항목과 추천 구조를 포함해주세요.
리뷰를 달아주세요

@yeonjin719 yeonjin719 requested a review from yujin5959 June 18, 2026 05:16
@yeonjin719 yeonjin719 self-assigned this Jun 18, 2026
Copilot AI review requested due to automatic review settings June 18, 2026 05:16
@yeonjin719 yeonjin719 linked an issue Jun 18, 2026 that may be closed by this pull request
2 tasks

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

리드미를 프로젝트 소개 중심으로 재구성하고(로고/커버 이미지 포함), 개발 환경/스크립트/컨벤션 정보를 최신화한 문서 PR입니다.

Changes:

  • 상단 히어로 영역(로고, 한 줄 소개, 커버 이미지, 배지) 추가 및 전체 구성 재정렬
  • Tech Stack / Getting Started / Scripts / Env / Project Structure / Conventions 섹션 보강
  • Contributors 및 푸터 정리

한 줄 요약

README의 여러 표가 ||로 시작해 GitHub에서 빈 컬럼이 생기며 표 렌더링이 깨질 수 있습니다.

발견된 위반 항목

  • README.md: Tech Stack / Scripts / Environment Variables / Contributors 표가 ||로 시작하여 첫 번째 빈 컬럼이 생성됨(표 레이아웃 깨짐)

추천 구조

README.md
├── Hero (logo/summary/cover/badges)
├── Overview
├── Table of Contents
├── Tech Stack
├── Getting Started
├── Scripts
├── Environment Variables
├── Project Structure (+ Import Alias)
├── Conventions
└── Contributors (+ footer)

최소 리팩토링 단계

  1. README 내 모든 표의 시작 구분자를 |||로 변경
  2. 헤더/구분선 행도 | --- | --- | 형태로 통일
  3. GitHub Preview(웹)에서 표가 2열로 정상 렌더링되는지 확인
  4. (선택) 로컬에서 마크다운 렌더러(IDE)에서도 동일하게 보이는지 확인

Comment thread README.md
Comment thread README.md
Comment thread README.md
Comment thread README.md
@yeonjin719 yeonjin719 moved this from Backlog to In review in Calio - Frontend Jun 18, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

Status: In review

Development

Successfully merging this pull request may close these issues.

📃 [Docs] README 수정

2 participants