Skip to content

docs: README 보완#337

Merged
Yun-Jinwoo merged 1 commit intomainfrom
fix/update-readme
Mar 14, 2026
Merged

docs: README 보완#337
Yun-Jinwoo merged 1 commit intomainfrom
fix/update-readme

Conversation

@shionpark
Copy link
Copy Markdown
Contributor

@shionpark shionpark commented Mar 4, 2026

연관된 이슈

해당 없음

작업 내용

프로젝트 README를 실제 코드베이스 기준으로 보완했습니다.

  • 프로젝트 개요: 기간 추가 (2025.11.21 ~ 2026.01.05)
  • 기술 스택: 버전 명시, 누락 항목 추가 및 오기재 수정
    • Zustand → 미사용으로 제거
    • Axios → Fetch API로 수정
    • Forms(React Hook Form, Zod), Storage(AWS S3), Suspensive 추가
  • 폴더 구조: 실제 디렉토리 기준으로 수정
    • api/, constants/, context/, server/, styles/ 추가
    • stores/store/ 수정
  • 테스트 계정: 신규 섹션 추가
  • 기여도와 역할: 팀원별 역할 및 GitHub 프로필 추가 (presentation.md 파일 참고)
  • 결과 및 성과: 구현 완료 기능 목록 추가

리뷰 요구사항 (선택)

기여도와 역할 섹션에서 각자 역할 내용이 정확한지 확인 부탁드립니다.

Summary by CodeRabbit

Documentation

  • 기술 스택 정보를 최신 버전 및 구체적인 도구로 업데이트
  • 테스트 계정 정보 섹션 추가
  • 프로젝트 폴더 구조 및 아키텍처 설명 개선
  • 팀 역할 및 기여도 관련 문서 업데이트
  • 파일 구조 예시 최신화

@shionpark shionpark self-assigned this Mar 4, 2026
@shionpark shionpark added the documentation 문서 관련 작업 (오타 수정, 내용 보강 등) label Mar 4, 2026
@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Mar 4, 2026

Walkthrough

README.md 파일이 기술 스택, 아키텍처, 폴더 구조, 테스트 계정 정보, 팀 구성을 포함하도록 포괄적으로 업데이트되었습니다. 프로젝트 구조와 요구사항을 명확하게 문서화하는 내용 확장입니다.

Changes

Cohort / File(s) Summary
문서 구조 및 기술 스택 업데이트
README.md
기술 스택 테이블이 프레임워크, 언어, 스타일링, 상태 관리, 데이터 fetching, 테스트, CI/CD, 호스팅을 명시적으로 구분하여 확장되었으며, 구체적인 버전 정보가 포함되었습니다. 아키텍처 설명에서 Tanstack Query 중심으로 통일되고 테스트 계정 섹션이 새로 추가되었습니다.
프로젝트 구조 및 폴더 구성 문서화
README.md
앱 루트 폴더 구조가 상세히 문서화되었으며, components, constants, contexts, hooks, utils 등 각 디렉터리의 목적과 구성이 명확하게 정의되었습니다. 실제 파일 트리 예시도 새로운 구조에 맞춰 업데이트되었습니다.
팀 정보 및 성과 표 추가
README.md
팀원별 역할 및 구현 내용을 정리한 기여도 표와 주요 기능 및 성과를 설명하는 결과 표가 추가되었습니다.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

Suggested reviewers

  • Yun-Jinwoo
  • junyeongh

Poem

🐰 문서 정리하며 깡충깡충,
기술 스택 반짝이고 폴더 구조 쭉쭉,
테스트 계정에 팀 소개까지,
프로젝트 흐름 이제 명확하네! 🌟

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed PR 제목 'docs: README 보완'은 README 파일 보완이라는 주요 변경 사항을 명확하게 요약하고 있습니다.
Description check ✅ Passed PR 설명은 템플릿의 필수 섹션(연관된 이슈, 작업 내용)을 포함하고 있으며, 구체적인 변경사항과 상세한 작업 내용을 제공합니다.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch fix/update-readme

Tip

Try Coding Plans. Let us write the prompt for your AI agent so you can ship faster (with fewer bugs).
Share your feedback on Discord.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@github-actions
Copy link
Copy Markdown

github-actions bot commented Mar 4, 2026

🧷 배포 미리보기: https://run-14r2i1lxd-shionparks-projects.vercel.app
최종 업데이트: 2026년 03월 04일 23시 28분

Copy link
Copy Markdown

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 3

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@README.md`:
- Around line 41-44: Remove the plaintext password exposed for the test account
(the table row containing "test22@example.com" and "a1234567!") from the README,
replacing it with a non-sensitive example or an instruction like "password
removed — contact team/documents/secret manager" and/or document a secure method
(e.g., reference to your secret manager or rotation policy) for obtaining test
credentials; do not leave real credentials in the public README.
- Around line 93-96: The <img> tags for contributor avatars lack alt attributes
which hurts screen-reader accessibility; update each avatar <img> element (the
ones with src URLs ending in u/52899088, u/79674766, u/127362044, u/46639511 and
the corresponding contributor names 석준, 서영, 진우, 준영) to include descriptive alt
text such as "Profile image of 석준", "Profile image of 서영", "Profile image of
진우", and "Profile image of 준영" respectively so screen readers can convey who
each image represents.
- Around line 91-97: The README and presentation.md disagree on Junyoung (준영 /
junyeongh)'s responsibilities: README lists "Session·Crew·Review Card, Fixed
Bottom Bar, Button 공통 컴포넌트 구현" but presentation.md omits these; pick the
authoritative source (README or presentation.md) and make them consistent by
either adding Junyoung's component work to presentation.md (include the exact
phrasing "Session·Crew·Review Card, Fixed Bottom Bar, Button 공통 컴포넌트 구현" near
the presentation.md section around the existing API/crew detail notes) or by
removing/adjusting that line in README under the "준영 (junyeongh)" entry so both
documents match; ensure the same exact terminology for the components and author
name "준영 (junyeongh)" is used in both places.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 09f7e2d3-0e45-4e91-b1a7-2104572defb5

📥 Commits

Reviewing files that changed from the base of the PR and between 61aa48c and 7edf385.

📒 Files selected for processing (1)
  • README.md

Comment on lines +41 to +44
| 이메일 | 비밀번호 |
| ------------------ | --------- |
| test22@example.com | a1234567! |

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟠 Major

공개 README에 테스트 계정 비밀번호를 평문 노출하지 마세요.

Line 41~44처럼 자격증명을 공개 저장소에 직접 노출하면 오남용/계정 잠금/운영 장애로 이어질 수 있습니다. 테스트 계정은 비밀번호를 제거하고, 별도 안전 채널(예: 팀 문서/시크릿 관리)로 전달하거나 주기적 로테이션 정책을 명시하는 형태로 바꾸는 것을 권장합니다.

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@README.md` around lines 41 - 44, Remove the plaintext password exposed for
the test account (the table row containing "test22@example.com" and "a1234567!")
from the README, replacing it with a non-sensitive example or an instruction
like "password removed — contact team/documents/secret manager" and/or document
a secure method (e.g., reference to your secret manager or rotation policy) for
obtaining test credentials; do not leave real credentials in the public README.

Comment on lines +91 to +97
| 팀원 | 역할 |
| :-------------------------------------------------------------------------------------------------------------------------------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| <img src="https://avatars.githubusercontent.com/u/52899088?v=4" width="80" height="80"> <br> **[석준](https://github.com/KSJ27)** | - 테스트 환경 설정 <br> - 지도·주소 보기·설정, 세션 상세 보기, 세션 생성·수정, 세션 찜하기 구현 <br> - Header, Button, UserAvatar, Tabs, Textarea, Modal 공통 컴포넌트 개발 |
| <img src="https://avatars.githubusercontent.com/u/79674766?v=4" width="80" height="80"> <br> **[서영](https://github.com/shionpark)** | - 세션·크루 목록 구현 (필터링, 무한 스크롤) <br> - Suspensive 적용 (초기 로딩 / 추가 로딩 분리) <br> - React Hook Form + Zod 기반 폼 유효성 검사 도입 <br> - CI/CD 파이프라인, ESLint 규칙, PR 템플릿 기반 협업 환경 구축 |
| <img src="https://avatars.githubusercontent.com/u/127362044?v=4" width="80" height="80"> <br> **[진우](https://github.com/Yun-Jinwoo)** | - Husky 기반 협업 환경 구축 <br> - Tanstack Query 전반 구조 설계 및 초기 세팅 <br> - Proxy 기반 로그인 상태에 따른 페이지 접근 제어 구현 <br> - 마이페이지 기능 구현 |
| <img src="https://avatars.githubusercontent.com/u/46639511?v=4" width="80" height="80"> <br> **[준영](https://github.com/junyeongh)** | - Tanstack Query 연동을 고려한 API 및 인증 전반 구조 설계 <br> - 무한 스크롤과 페이지네이션을 활용한 크루 상세 페이지 구현 <br> - Session·Crew·Review Card, Fixed Bottom Bar, Button 공통 컴포넌트 구현 |

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🔴 Critical

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash
# README.md와 presentation.md 내용 비교 검증

echo "== 1. presentation.md 파일 위치 확인 =="
fd -t f 'presentation\.md' || fd -t f 'presentation' 2>/dev/null

echo
echo "== 2. README.md의 기여도와 역할 섹션 추출 =="
grep -n "팀원\|역할" README.md | head -20

echo
echo "== 3. README.md 라인 수 확인 =="
wc -l README.md

echo
echo "== 4. README.md 91-97 라인 출력 =="
sed -n '85,105p' README.md

echo
echo "== 5. 저장소 루트의 모든 .md 파일 목록 =="
fd -t f -e md

Repository: runfit26/run-fit

Length of output: 3338


🏁 Script executed:

#!/bin/bash
# presentation.md 전체 내용 확인

echo "== presentation.md 파일 크기 =="
wc -l presentation.md

echo
echo "== presentation.md 전체 내용 =="
cat -n presentation.md

echo
echo "== presentation.md에서 팀원/역할/기여 관련 섹션 =="
rg -n '팀원|역할|기여|석준|서영|진우|준영' presentation.md

Repository: runfit26/run-fit

Length of output: 21330


README의 "기여도와 역할" 섹션과 presentation.md 내용 불일치 확인

준영(junyeongh)의 역할 설명에 불일치가 있습니다:

  • README.md (91-104줄): "Session·Crew·Review Card, Fixed Bottom Bar, Button 공통 컴포넌트 구현"이 명시됨
  • presentation.md (128-130줄): 해당 컴포넌트 구현 내용이 없음 (API 설계, 크루 상세 페이지만 기재)

두 문서를 일치시켜 README 신뢰도를 확보하세요.

🧰 Tools
🪛 markdownlint-cli2 (0.21.0)

[warning] 93-93: Images should have alternate text (alt text)

(MD045, no-alt-text)


[warning] 94-94: Images should have alternate text (alt text)

(MD045, no-alt-text)


[warning] 95-95: Images should have alternate text (alt text)

(MD045, no-alt-text)


[warning] 96-96: Images should have alternate text (alt text)

(MD045, no-alt-text)

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@README.md` around lines 91 - 97, The README and presentation.md disagree on
Junyoung (준영 / junyeongh)'s responsibilities: README lists "Session·Crew·Review
Card, Fixed Bottom Bar, Button 공통 컴포넌트 구현" but presentation.md omits these; pick
the authoritative source (README or presentation.md) and make them consistent by
either adding Junyoung's component work to presentation.md (include the exact
phrasing "Session·Crew·Review Card, Fixed Bottom Bar, Button 공통 컴포넌트 구현" near
the presentation.md section around the existing API/crew detail notes) or by
removing/adjusting that line in README under the "준영 (junyeongh)" entry so both
documents match; ensure the same exact terminology for the components and author
name "준영 (junyeongh)" is used in both places.

Comment on lines +93 to +96
| <img src="https://avatars.githubusercontent.com/u/52899088?v=4" width="80" height="80"> <br> **[석준](https://github.com/KSJ27)** | - 테스트 환경 설정 <br> - 지도·주소 보기·설정, 세션 상세 보기, 세션 생성·수정, 세션 찜하기 구현 <br> - Header, Button, UserAvatar, Tabs, Textarea, Modal 공통 컴포넌트 개발 |
| <img src="https://avatars.githubusercontent.com/u/79674766?v=4" width="80" height="80"> <br> **[서영](https://github.com/shionpark)** | - 세션·크루 목록 구현 (필터링, 무한 스크롤) <br> - Suspensive 적용 (초기 로딩 / 추가 로딩 분리) <br> - React Hook Form + Zod 기반 폼 유효성 검사 도입 <br> - CI/CD 파이프라인, ESLint 규칙, PR 템플릿 기반 협업 환경 구축 |
| <img src="https://avatars.githubusercontent.com/u/127362044?v=4" width="80" height="80"> <br> **[진우](https://github.com/Yun-Jinwoo)** | - Husky 기반 협업 환경 구축 <br> - Tanstack Query 전반 구조 설계 및 초기 세팅 <br> - Proxy 기반 로그인 상태에 따른 페이지 접근 제어 구현 <br> - 마이페이지 기능 구현 |
| <img src="https://avatars.githubusercontent.com/u/46639511?v=4" width="80" height="80"> <br> **[준영](https://github.com/junyeongh)** | - Tanstack Query 연동을 고려한 API 및 인증 전반 구조 설계 <br> - 무한 스크롤과 페이지네이션을 활용한 크루 상세 페이지 구현 <br> - Session·Crew·Review Card, Fixed Bottom Bar, Button 공통 컴포넌트 구현 |
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

프로필 이미지에 alt 텍스트를 추가해주세요.

Line 93~96의 <img> 태그에 대체 텍스트가 없어 스크린리더 접근성이 떨어집니다.

접근성 개선 예시(diff)
-|    <img src="https://avatars.githubusercontent.com/u/52899088?v=4" width="80" height="80"> <br> **[석준](https://github.com/KSJ27)**    | - 테스트 환경 설정 <br> - 지도·주소 보기·설정, 세션 상세 보기, 세션 생성·수정, 세션 찜하기 구현 <br> - Header, Button, UserAvatar, Tabs, Textarea, Modal 공통 컴포넌트 개발                                               |
-|  <img src="https://avatars.githubusercontent.com/u/79674766?v=4" width="80" height="80"> <br> **[서영](https://github.com/shionpark)**  | - 세션·크루 목록 구현 (필터링, 무한 스크롤) <br> - Suspensive 적용 (초기 로딩 / 추가 로딩 분리) <br> - React Hook Form + Zod 기반 폼 유효성 검사 도입 <br> - CI/CD 파이프라인, ESLint 규칙, PR 템플릿 기반 협업 환경 구축 |
-| <img src="https://avatars.githubusercontent.com/u/127362044?v=4" width="80" height="80"> <br> **[진우](https://github.com/Yun-Jinwoo)** | - Husky 기반 협업 환경 구축 <br> - Tanstack Query 전반 구조 설계 및 초기 세팅 <br> - Proxy 기반 로그인 상태에 따른 페이지 접근 제어 구현 <br> - 마이페이지 기능 구현                                                      |
-|  <img src="https://avatars.githubusercontent.com/u/46639511?v=4" width="80" height="80"> <br> **[준영](https://github.com/junyeongh)**  | - Tanstack Query 연동을 고려한 API 및 인증 전반 구조 설계 <br> - 무한 스크롤과 페이지네이션을 활용한 크루 상세 페이지 구현 <br> - Session·Crew·Review Card, Fixed Bottom Bar, Button 공통 컴포넌트 구현                   |
+|    <img src="https://avatars.githubusercontent.com/u/52899088?v=4" alt="석준 GitHub 프로필 이미지" width="80" height="80"> <br> **[석준](https://github.com/KSJ27)**    | - 테스트 환경 설정 <br> - 지도·주소 보기·설정, 세션 상세 보기, 세션 생성·수정, 세션 찜하기 구현 <br> - Header, Button, UserAvatar, Tabs, Textarea, Modal 공통 컴포넌트 개발                                               |
+|  <img src="https://avatars.githubusercontent.com/u/79674766?v=4" alt="서영 GitHub 프로필 이미지" width="80" height="80"> <br> **[서영](https://github.com/shionpark)**  | - 세션·크루 목록 구현 (필터링, 무한 스크롤) <br> - Suspensive 적용 (초기 로딩 / 추가 로딩 분리) <br> - React Hook Form + Zod 기반 폼 유효성 검사 도입 <br> - CI/CD 파이프라인, ESLint 규칙, PR 템플릿 기반 협업 환경 구축 |
+| <img src="https://avatars.githubusercontent.com/u/127362044?v=4" alt="진우 GitHub 프로필 이미지" width="80" height="80"> <br> **[진우](https://github.com/Yun-Jinwoo)** | - Husky 기반 협업 환경 구축 <br> - Tanstack Query 전반 구조 설계 및 초기 세팅 <br> - Proxy 기반 로그인 상태에 따른 페이지 접근 제어 구현 <br> - 마이페이지 기능 구현                                                      |
+|  <img src="https://avatars.githubusercontent.com/u/46639511?v=4" alt="준영 GitHub 프로필 이미지" width="80" height="80"> <br> **[준영](https://github.com/junyeongh)**  | - Tanstack Query 연동을 고려한 API 및 인증 전반 구조 설계 <br> - 무한 스크롤과 페이지네이션을 활용한 크루 상세 페이지 구현 <br> - Session·Crew·Review Card, Fixed Bottom Bar, Button 공통 컴포넌트 구현                   |
🧰 Tools
🪛 markdownlint-cli2 (0.21.0)

[warning] 93-93: Images should have alternate text (alt text)

(MD045, no-alt-text)


[warning] 94-94: Images should have alternate text (alt text)

(MD045, no-alt-text)


[warning] 95-95: Images should have alternate text (alt text)

(MD045, no-alt-text)


[warning] 96-96: Images should have alternate text (alt text)

(MD045, no-alt-text)

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@README.md` around lines 93 - 96, The <img> tags for contributor avatars lack
alt attributes which hurts screen-reader accessibility; update each avatar <img>
element (the ones with src URLs ending in u/52899088, u/79674766, u/127362044,
u/46639511 and the corresponding contributor names 석준, 서영, 진우, 준영) to include
descriptive alt text such as "Profile image of 석준", "Profile image of 서영",
"Profile image of 진우", and "Profile image of 준영" respectively so screen readers
can convey who each image represents.

@Yun-Jinwoo Yun-Jinwoo merged commit dd065d3 into main Mar 14, 2026
4 checks passed
@Yun-Jinwoo Yun-Jinwoo deleted the fix/update-readme branch March 14, 2026 13:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation 문서 관련 작업 (오타 수정, 내용 보강 등)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants