docs: #16 - README.md 작성#17
Conversation
워크스루프로젝트 헤더를 "27th-App-Team-1-iOS"에서 "NDGL-iOS"로 변경하고 README를 기술 스택, 모듈 구조, RIBs 아키텍처, 의존성 그래프, 브랜칭 규칙, CI/CD, 커밋 컨벤션, 코딩 컨벤션, 설정 단계, 팀 멤버 정보 등의 포괄적인 섹션으로 확장한 문서화 업데이트입니다. 변경 사항
예상 코드 리뷰 난이도🎯 1 (Trivial) | ⏱️ ~2 분 시
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. 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. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 4
🤖 Fix all issues with AI agents
In `@README.md`:
- Around line 222-240: The team member profile images in README.md (the <img>
tags for 김나훈 and 최안용) are missing alt attributes; update each <img> to include
descriptive alt text (e.g., alt="김나훈 GitHub profile" and alt="최안용 GitHub
profile") so the images are accessible and satisfy markdownlint MD045.
- Around line 4-7: Add descriptive alt text to each badge <img> tag (e.g., the
Swift-5.0, iOS-17.0+, Tuist-4.x, and Architecture-RIBs badges) so screen readers
can convey their meaning; locate the four <img src="..."> elements and add an
alt="..." attribute describing the badge text (for example "Swift 5.0", "iOS
17.0+", "Tuist 4.x", "Architecture: RIBs").
- Line 206: Replace the placeholder clone URL in README.md (the line "git clone
https://github.com/YourOrg/NDGL-iOS.git") with the real repository URL: either
update the org/name to "YAPP-Github/27th-App-Team-1-iOS" if that is the intended
repo (e.g., git clone https://github.com/YAPP-Github/27th-App-Team-1-iOS.git),
or change the org/name to the actual GitHub org and repo if you are renaming to
NDGL-iOS; also search README.md for any other occurrences of "YourOrg" or
"NDGL-iOS" and make consistent updates and confirm which canonical repo name to
use before committing.
- Line 4: The Swift version badge in README uses "Swift-5.0" (the img badge
string Swift-5.0-orange.svg) but the README requires Xcode 16.0+; update that
badge to reflect the correct Swift version (change the badge to Swift-5.9, or at
minimum Swift-5.8) and ensure the badge text matches the Xcode requirement
mentioned elsewhere in README (line referencing Xcode 16.0+).
🧹 Nitpick comments (4)
README.md (4)
30-53: 코드 블록에 언어 지정을 추가하세요.마크다운 모범 사례에 따라 펜스 코드 블록에 언어를 지정하는 것이 좋습니다. 디렉토리 구조의 경우
text또는plaintext를 사용할 수 있습니다.📝 제안 사항
-``` +```text NDGL-iOS ├── ProjectsBased on learnings: "markdownlint-cli2 flagged fenced code blocks should have a language specified (MD040)"
59-83: ASCII 다이어그램에 언어 지정을 추가하세요.다이어그램 코드 블록에도
text언어 지정을 추가하면 더 나은 렌더링을 보장할 수 있습니다.📝 제안 사항
-``` +```text ┌─────────────────────────────────────────────────┐Based on learnings: "markdownlint-cli2 flagged fenced code blocks should have a language specified (MD040)"
87-133: 모듈 의존성 다이어그램에 언어 지정을 추가하세요.의존성 다이어그램 코드 블록에도
text언어 지정을 추가하는 것이 좋습니다.📝 제안 사항
-``` +```text ┌─────────┐Based on learnings: "markdownlint-cli2 flagged fenced code blocks should have a language specified (MD040)"
173-175: 커밋 예시 코드 블록에 언어 지정을 추가하세요.커밋 메시지 예시 코드 블록에
text언어 지정을 추가하는 것이 좋습니다.📝 제안 사항
-``` +```text feat: `#이슈번호` - 작업 내용</details> Based on learnings: "markdownlint-cli2 flagged fenced code blocks should have a language specified (MD040)" </blockquote></details> </blockquote></details> <!-- This is an auto-generated comment by CodeRabbit for review status -->
| <img src="https://img.shields.io/badge/Swift-5.0-orange.svg" /> | ||
| <img src="https://img.shields.io/badge/iOS-17.0+-blue.svg" /> | ||
| <img src="https://img.shields.io/badge/Tuist-4.x-purple.svg" /> | ||
| <img src="https://img.shields.io/badge/Architecture-RIBs-green.svg" /> |
There was a problem hiding this comment.
뱃지 이미지에 대체 텍스트(alt text)를 추가하세요.
접근성 향상을 위해 모든 뱃지 이미지에 alt 속성을 추가해야 합니다. 스크린 리더 사용자를 위해 각 뱃지가 나타내는 내용을 설명하는 텍스트가 필요합니다.
♿ 접근성 개선을 위한 제안
<p align="center">
- <img src="https://img.shields.io/badge/Swift-5.0-orange.svg" />
- <img src="https://img.shields.io/badge/iOS-17.0+-blue.svg" />
- <img src="https://img.shields.io/badge/Tuist-4.x-purple.svg" />
- <img src="https://img.shields.io/badge/Architecture-RIBs-green.svg" />
+ <img src="https://img.shields.io/badge/Swift-5.0-orange.svg" alt="Swift 5.0" />
+ <img src="https://img.shields.io/badge/iOS-17.0+-blue.svg" alt="iOS 17.0 이상" />
+ <img src="https://img.shields.io/badge/Tuist-4.x-purple.svg" alt="Tuist 4.x" />
+ <img src="https://img.shields.io/badge/Architecture-RIBs-green.svg" alt="RIBs 아키텍처" />
</p>Based on learnings: "markdownlint-cli2 flagged missing alt text for images (MD045)"
📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| <img src="https://img.shields.io/badge/Swift-5.0-orange.svg" /> | |
| <img src="https://img.shields.io/badge/iOS-17.0+-blue.svg" /> | |
| <img src="https://img.shields.io/badge/Tuist-4.x-purple.svg" /> | |
| <img src="https://img.shields.io/badge/Architecture-RIBs-green.svg" /> | |
| <p align="center"> | |
| <img src="https://img.shields.io/badge/Swift-5.0-orange.svg" alt="Swift 5.0" /> | |
| <img src="https://img.shields.io/badge/iOS-17.0+-blue.svg" alt="iOS 17.0 이상" /> | |
| <img src="https://img.shields.io/badge/Tuist-4.x-purple.svg" alt="Tuist 4.x" /> | |
| <img src="https://img.shields.io/badge/Architecture-RIBs-green.svg" alt="RIBs 아키텍처" /> | |
| </p> |
🧰 Tools
🪛 markdownlint-cli2 (0.18.1)
4-4: Images should have alternate text (alt text)
(MD045, no-alt-text)
5-5: Images should have alternate text (alt text)
(MD045, no-alt-text)
6-6: Images should have alternate text (alt text)
(MD045, no-alt-text)
7-7: Images should have alternate text (alt text)
(MD045, no-alt-text)
🤖 Prompt for AI Agents
In `@README.md` around lines 4 - 7, Add descriptive alt text to each badge <img>
tag (e.g., the Swift-5.0, iOS-17.0+, Tuist-4.x, and Architecture-RIBs badges) so
screen readers can convey their meaning; locate the four <img src="...">
elements and add an alt="..." attribute describing the badge text (for example
"Swift 5.0", "iOS 17.0+", "Tuist 4.x", "Architecture: RIBs").
| # NDGL-iOS | ||
|
|
||
| <p align="center"> | ||
| <img src="https://img.shields.io/badge/Swift-5.0-orange.svg" /> |
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
# Check for Swift version configuration in the project
rg -n "swiftVersion|swift_version|SWIFT_VERSION" --type-list | head -20Repository: YAPP-Github/27th-App-Team-1-iOS
Length of output: 464
🏁 Script executed:
# Check if this is a Swift package, find Package.swift or similar config
fd -e "Package.swift" -e "package.json" -e "Podfile" -e ".swift-version" -e "project.pbxproj" | head -20Repository: YAPP-Github/27th-App-Team-1-iOS
Length of output: 57
🏁 Script executed:
# Read the README to check line 198 and surrounding context
wc -l README.mdRepository: YAPP-Github/27th-App-Team-1-iOS
Length of output: 88
🏁 Script executed:
# Check what's around line 198 in README
sed -n '190,205p' README.mdRepository: YAPP-Github/27th-App-Team-1-iOS
Length of output: 343
🏁 Script executed:
# Find and check Project.swift or similar configuration
find . -name "Project.swift" -o -name "project.pbxproj" | head -5Repository: YAPP-Github/27th-App-Team-1-iOS
Length of output: 251
🏁 Script executed:
# Check for .swift-version file
cat .swift-version 2>/dev/null || echo "No .swift-version file found"Repository: YAPP-Github/27th-App-Team-1-iOS
Length of output: 103
🏁 Script executed:
# Search for Swift version configuration in all files
rg "5\.0|5\.9|swiftLanguageVersion|minimumDeploymentVersion" -n --max-count 20Repository: YAPP-Github/27th-App-Team-1-iOS
Length of output: 50387
🏁 Script executed:
# Check Tuist configuration if it exists
fd -name "Project.swift" -exec head -100 {} \;Repository: YAPP-Github/27th-App-Team-1-iOS
Length of output: 305
🏁 Script executed:
# Read the main App project configuration
head -150 "./Projects/App/Project.swift" | cat -nRepository: YAPP-Github/27th-App-Team-1-iOS
Length of output: 889
🏁 Script executed:
# Search for swiftVersion or language version settings in Project files
rg "swiftVersion|languageVersion|\.swift" "./Projects/App/Project.swift" -A 2 -B 2Repository: YAPP-Github/27th-App-Team-1-iOS
Length of output: 291
🏁 Script executed:
# Search for appSettings function and Swift version configuration
rg "appSettings|swiftLanguageVersion" "./Projects" -A 5 -B 2Repository: YAPP-Github/27th-App-Team-1-iOS
Length of output: 357
🏁 Script executed:
# Check Tuist configuration files
fd "Settings\|settings" "./Projects" --type f | head -10Repository: YAPP-Github/27th-App-Team-1-iOS
Length of output: 57
🏁 Script executed:
# Look for Swift version in ConfigPlugin or similar
rg "\.swift\(\"5\|swiftLanguageVersion" "./Projects" -A 2 -B 2Repository: YAPP-Github/27th-App-Team-1-iOS
Length of output: 57
🏁 Script executed:
# Find where appSettings is defined
rg "appSettings" --type swift -A 10Repository: YAPP-Github/27th-App-Team-1-iOS
Length of output: 1648
🏁 Script executed:
# Look for ConfigPlugin definition
find . -name "ConfigPlugin*" -o -name "*Config*" | grep -E "\.(swift|yml)$" | head -10Repository: YAPP-Github/27th-App-Team-1-iOS
Length of output: 218
🏁 Script executed:
# Check Plugins directory for configuration
fd "Config" "./Plugins" --type fRepository: YAPP-Github/27th-App-Team-1-iOS
Length of output: 144
🏁 Script executed:
# Check the full Settings+Extension.swift file to see complete Swift version configuration
cat "./Plugins/EnvPlugin/ProjectDescriptionHelpers/Settings+Extension.swift"Repository: YAPP-Github/27th-App-Team-1-iOS
Length of output: 3591
🏁 Script executed:
# Check if there's any minimum iOS deployment version that could hint at Swift version
rg "IPHONEOS_DEPLOYMENT_TARGET|deploymentTarget" "./Plugins" -A 2 -B 2Repository: YAPP-Github/27th-App-Team-1-iOS
Length of output: 4767
🏁 Script executed:
# Check Environment.swift for complete Xcode/deployment configuration
cat "./Plugins/EnvPlugin/ProjectDescriptionHelpers/Environment.swift" | head -50Repository: YAPP-Github/27th-App-Team-1-iOS
Length of output: 827
🏁 Script executed:
# Check README for exact Xcode requirement
sed -n '190,205p' README.mdRepository: YAPP-Github/27th-App-Team-1-iOS
Length of output: 343
Swift 버전 뱃지를 업데이트하세요.
Xcode 16.0+를 요구사항으로 명시했는데(README 198줄), 뱃지는 Swift 5.0으로 표시되어 있습니다. Xcode 16.0은 Swift 5.9 이상과 함께 제공되고, iOS 17.0 지원에는 최소 Swift 5.8이 필요합니다. 뱃지를 Swift 5.9로 업데이트하거나 최소 Swift 5.8 이상으로 변경해야 합니다.
🧰 Tools
🪛 markdownlint-cli2 (0.18.1)
4-4: Images should have alternate text (alt text)
(MD045, no-alt-text)
🤖 Prompt for AI Agents
In `@README.md` at line 4, The Swift version badge in README uses "Swift-5.0" (the
img badge string Swift-5.0-orange.svg) but the README requires Xcode 16.0+;
update that badge to reflect the correct Swift version (change the badge to
Swift-5.9, or at minimum Swift-5.8) and ensure the badge text matches the Xcode
requirement mentioned elsewhere in README (line referencing Xcode 16.0+).
|
|
||
| ```bash | ||
| # 1. 저장소 클론 | ||
| git clone https://github.com/YourOrg/NDGL-iOS.git |
There was a problem hiding this comment.
플레이스홀더 URL을 실제 저장소 URL로 수정하세요.
YourOrg는 플레이스홀더입니다. 실제 GitHub 조직명과 저장소명으로 교체해야 합니다. 이 상태로는 사용자가 저장소를 클론할 수 없습니다.
PR URL을 기반으로 실제 저장소는 YAPP-Github/27th-App-Team-1-iOS인 것으로 보입니다. 저장소명을 NDGL-iOS로 변경할 예정인지, 아니면 현재 저장소명을 사용해야 하는지 확인이 필요합니다.
🔧 제안된 수정
저장소명을 NDGL-iOS로 변경하는 경우:
-git clone https://github.com/YourOrg/NDGL-iOS.git
+git clone https://github.com/YAPP-Github/NDGL-iOS.git
cd NDGL-iOS현재 저장소명을 유지하는 경우:
-git clone https://github.com/YourOrg/NDGL-iOS.git
-cd NDGL-iOS
+git clone https://github.com/YAPP-Github/27th-App-Team-1-iOS.git
+cd 27th-App-Team-1-iOS📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| git clone https://github.com/YourOrg/NDGL-iOS.git | |
| git clone https://github.com/YAPP-Github/NDGL-iOS.git |
🤖 Prompt for AI Agents
In `@README.md` at line 206, Replace the placeholder clone URL in README.md (the
line "git clone https://github.com/YourOrg/NDGL-iOS.git") with the real
repository URL: either update the org/name to "YAPP-Github/27th-App-Team-1-iOS"
if that is the intended repo (e.g., git clone
https://github.com/YAPP-Github/27th-App-Team-1-iOS.git), or change the org/name
to the actual GitHub org and repo if you are renaming to NDGL-iOS; also search
README.md for any other occurrences of "YourOrg" or "NDGL-iOS" and make
consistent updates and confirm which canonical repo name to use before
committing.
| ## 👥 팀원 | ||
|
|
||
| <table> | ||
| <tr> | ||
| <td align="center"> | ||
| <a href="https://github.com/KimNahun"> | ||
| <img src="https://github.com/KimNahun.png" width="120" /> | ||
| <br /> | ||
| <b>김나훈</b> | ||
| </a> | ||
| </td> | ||
| <td align="center"> | ||
| <a href="https://github.com/ChoiAnYong"> | ||
| <img src="https://github.com/ChoiAnYong.png" width="120" /> | ||
| <br /> | ||
| <b>최안용</b> | ||
| </a> | ||
| </td> | ||
| </tr> |
There was a problem hiding this comment.
팀원 프로필 이미지에 대체 텍스트를 추가하세요.
접근성 향상을 위해 팀원 프로필 이미지에도 alt 속성을 추가해야 합니다.
♿ 접근성 개선을 위한 제안
<td align="center">
<a href="https://github.com/KimNahun">
- <img src="https://github.com/KimNahun.png" width="120" />
+ <img src="https://github.com/KimNahun.png" width="120" alt="김나훈 프로필" />
<br />
<b>김나훈</b>
</a>
</td>
<td align="center">
<a href="https://github.com/ChoiAnYong">
- <img src="https://github.com/ChoiAnYong.png" width="120" />
+ <img src="https://github.com/ChoiAnYong.png" width="120" alt="최안용 프로필" />
<br />
<b>최안용</b>
</a>
</td>Based on learnings: "markdownlint-cli2 flagged missing alt text for images (MD045)"
🧰 Tools
🪛 markdownlint-cli2 (0.18.1)
228-228: Images should have alternate text (alt text)
(MD045, no-alt-text)
235-235: Images should have alternate text (alt text)
(MD045, no-alt-text)
🤖 Prompt for AI Agents
In `@README.md` around lines 222 - 240, The team member profile images in
README.md (the <img> tags for 김나훈 and 최안용) are missing alt attributes; update
each <img> to include descriptive alt text (e.g., alt="김나훈 GitHub profile" and
alt="최안용 GitHub profile") so the images are accessible and satisfy markdownlint
MD045.
2 participants
🔗 연결된 이슈
📄 작업 내용
💻 주요 코드 설명
README.mdSummary by CodeRabbit
릴리스 노트
✏️ Tip: You can customize this high-level summary in your review settings.