Merged
Conversation
Updated README with new images, features, and tech stack details.
Updated the README.md to improve service description and QR scan functionality.
Closed
1 task
개요README.md 파일이 대규모로 재작성되고 구조가 개편되었습니다. 헤더 이미지, 새로운 섹션(기여자, 기술 스택, 아키텍처, 컨벤션), 그리고 프로젝트 구조 설명이 추가되었으며, 기존 내용이 재구성되었습니다. 변경사항
예상 코드 리뷰 노력🎯 3 (Moderate) | ⏱️ ~25 분 🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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: 3
🧹 Nitpick comments (1)
README.md (1)
20-20: README 내 TODO 주석은 이슈로 분리하는 편이 좋겠습니다.Line 20의
<!-- 기능 소개 PPT 추가 예정 -->는 배포 문서에 남기기보다 GitHub Issue로 추적하는 편이 유지보수에 유리합니다.원하시면 TODO를 템플릿화한 이슈 본문(완료 조건/담당/마감 포함)으로 바로 작성해드릴게요.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@README.md` at line 20, Remove the inline README TODO comment `<!-- 기능 소개 PPT 추가 예정 -->` and create a tracked GitHub Issue instead; update README.md to delete that HTML comment and, when creating the Issue, use a template that includes title, description, acceptance criteria, assignee, and due date so the work referenced by the deleted comment is tracked (you can copy the comment text into the Issue body).
🤖 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`:
- Line 9: Add meaningful alt text to the inline <img> tags used in the README,
e.g., the image in the "#### QR 스캔 한 번으로 앨범에 즉시 저장" heading and the other
occurrences noted (lines 11,13,15,17,24,26,32,51,111,138); locate the markdown
image tags (the <img ... /> elements) and add a descriptive alt attribute
(alt="...") that conveys the icon/banner purpose for screen reader users,
keeping the alt concise and context-specific.
- Line 7: The heading at line containing "### 네컷사진의 시작부터 보관까지, 당신의 기록을 완성하는
서비스" skips from H1 to H3 and uses two spaces after the hashes; change the
heading level to the appropriate sequential level (e.g., use "##" if the
previous is H1) and normalize spacing to a single space after the hash marks,
and make the same single-space/level fix for the other affected heading (the one
at the line matching the same pattern around line 55) so all headings follow
consistent H1→H2→H3 order and use one space after '#'.
- Line 26: The contributor avatar image tags in the README use an incorrect
height attribute (height="3400") which breaks layout; update the <img> elements
(the ones with width="200px" height="3400" and their counterpart) to use a
sensible height (e.g., height="200px") or remove the height attribute and rely
on width/CSS for consistent sizing so both avatar images render properly and the
README layout is not broken.
---
Nitpick comments:
In `@README.md`:
- Line 20: Remove the inline README TODO comment `<!-- 기능 소개 PPT 추가 예정 -->` and
create a tracked GitHub Issue instead; update README.md to delete that HTML
comment and, when creating the Issue, use a template that includes title,
description, acceptance criteria, assignee, and due date so the work referenced
by the deleted comment is tracked (you can copy the comment text into the Issue
body).
| > “Neki, 네컷의 순간이 이어지는 곳” | ||
|
|
||
| ## Foldering | ||
| ### 네컷사진의 시작부터 보관까지, 당신의 기록을 완성하는 서비스 |
There was a problem hiding this comment.
헤딩 레벨/공백 규칙을 맞춰 문서 구조를 안정화해주세요.
Line 7은 H1 -> H3로 한 단계 건너뛰고 있고, Line 7/Line 55 모두 ### 처럼 해시 뒤 공백이 2칸입니다. 렌더링은 되더라도 문서 목차/린트 일관성이 깨집니다.
수정 예시
-### 네컷사진의 시작부터 보관까지, 당신의 기록을 완성하는 서비스
+## 네컷사진의 시작부터 보관까지, 당신의 기록을 완성하는 서비스
-### Micro Clean Architecture
+### Micro Clean ArchitectureAlso applies to: 55-55
🧰 Tools
🪛 markdownlint-cli2 (0.21.0)
[warning] 7-7: Heading levels should only increment by one level at a time
Expected: h2; Actual: h3
(MD001, heading-increment)
[warning] 7-7: Multiple spaces after hash on atx style heading
(MD019, no-multiple-space-atx)
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@README.md` at line 7, The heading at line containing "### 네컷사진의 시작부터 보관까지,
당신의 기록을 완성하는 서비스" skips from H1 to H3 and uses two spaces after the hashes;
change the heading level to the appropriate sequential level (e.g., use "##" if
the previous is H1) and normalize spacing to a single space after the hash
marks, and make the same single-space/level fix for the other affected heading
(the one at the line matching the same pattern around line 55) so all headings
follow consistent H1→H2→H3 order and use one space after '#'.
| ### 네컷사진의 시작부터 보관까지, 당신의 기록을 완성하는 서비스 | ||
|
|
||
| ```Text | ||
| #### <img width="30" height="30" src="https://github.com/user-attachments/assets/7ec36287-820f-4efb-9c46-dc9c85e92263" /> QR 스캔 한 번으로 앨범에 즉시 저장 |
There was a problem hiding this comment.
인라인 이미지에 alt를 추가해 접근성을 보완해주세요.
여러 이미지 태그에 대체 텍스트가 없어 스크린리더 사용자에게 정보가 전달되지 않습니다. 특히 섹션 아이콘/배너는 문맥 전달용이라 alt가 필요합니다.
수정 예시
-#### <img width="30" height="30" src="https://github.com/user-attachments/assets/7ec36287-820f-4efb-9c46-dc9c85e92263" /> QR 스캔 한 번으로 앨범에 즉시 저장
+#### <img width="30" height="30" alt="QR 저장 아이콘" src="https://github.com/user-attachments/assets/7ec36287-820f-4efb-9c46-dc9c85e92263" /> QR 스캔 한 번으로 앨범에 즉시 저장
-<img width="3240" height="400" src="https://github.com/user-attachments/assets/fee4035c-4bac-4921-95ec-93318bd2bdf9" />
+<img width="3240" height="400" alt="NEKI 푸터 배너" src="https://github.com/user-attachments/assets/fee4035c-4bac-4921-95ec-93318bd2bdf9" />Also applies to: 11-11, 13-13, 15-15, 17-17, 24-24, 26-26, 32-32, 51-51, 111-111, 138-138
🧰 Tools
🪛 markdownlint-cli2 (0.21.0)
[warning] 9-9: 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` at line 9, Add meaningful alt text to the inline <img> tags used
in the README, e.g., the image in the "#### QR 스캔 한 번으로 앨범에 즉시 저장" heading and
the other occurrences noted (lines 11,13,15,17,24,26,32,51,111,138); locate the
markdown image tags (the <img ... /> elements) and add a descriptive alt
attribute (alt="...") that conveys the icon/banner purpose for screen reader
users, keeping the alt concise and context-specific.
|
|
||
| ## <img width="40" height="40" src="https://github.com/user-attachments/assets/06940c34-fa04-461f-acd6-f6e121ffdd61" /> Contributors | ||
|
|
||
| | <img width="200px" height="3400" src="https://avatars.githubusercontent.com/u/99116619?v=4" /> | <img width="200px" height="3400" src="https://avatars.githubusercontent.com/u/63261054?v=4" /> | |
There was a problem hiding this comment.
Contributors 아바타 높이 값이 비정상적으로 큽니다.
Line 26의 height="3400"은 오타로 보이며 README 렌더링에서 레이아웃을 크게 깨뜨릴 수 있습니다.
수정 예시
-| <img width="200px" height="3400" src="https://avatars.githubusercontent.com/u/99116619?v=4" /> | <img width="200px" height="3400" src="https://avatars.githubusercontent.com/u/63261054?v=4" /> |
+| <img width="200" height="200" alt="Remaked-Swain 프로필" src="https://avatars.githubusercontent.com/u/99116619?v=4" /> | <img width="200" height="200" alt="OneTen19 프로필" src="https://avatars.githubusercontent.com/u/63261054?v=4" /> |📝 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.
Suggested change
| | <img width="200px" height="3400" src="https://avatars.githubusercontent.com/u/99116619?v=4" /> | <img width="200px" height="3400" src="https://avatars.githubusercontent.com/u/63261054?v=4" /> | | |
| | <img width="200" height="200" alt="Remaked-Swain 프로필" src="https://avatars.githubusercontent.com/u/99116619?v=4" /> | <img width="200" height="200" alt="OneTen19 프로필" src="https://avatars.githubusercontent.com/u/63261054?v=4" /> | |
🧰 Tools
🪛 markdownlint-cli2 (0.21.0)
[warning] 26-26: Images should have alternate text (alt text)
(MD045, no-alt-text)
[warning] 26-26: 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` at line 26, The contributor avatar image tags in the README use an
incorrect height attribute (height="3400") which breaks layout; update the <img>
elements (the ones with width="200px" height="3400" and their counterpart) to
use a sensible height (e.g., height="200px") or remove the height attribute and
rely on width/CSS for consistent sizing so both avatar images render properly
and the README layout is not broken.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
🌴 작업한 브랜치
docs#144✅ 작업한 내용
리꾸했습니다
네컷사진의 시작부터 보관까지, 당신의 기록을 완성하는 서비스
흩어져 있던 종이 사진과 디지털 파일을 NEKI 하나로 끝내세요. QR 스캔 한 번으로 앱에서 바로 저장하고, 날짜별/폴더별로 정리됩니다.
예전에 찍어둔 사진이나 QR 유효기간이 지난 사진도 직접 업로드하여 동일하게 관리할 수 있습니다.
카메라 앞에서 당황하지 마세요! NEKI가 제안하는 트렌디한 포즈와 '랜덤 포즈' 기능이 당신의 자연스러운 촬영을 도와드립니다.
지금 바로 찍고 싶을 때, 주변의 사진관을 확인하세요. 브랜드 필터를 사용해 내가 선호하는 브랜드만 골라 찾을 수 있습니다.
친구, 연인, 특별한 기념일 등 목적에 맞춰 폴더를 만들고 소중한 순간들을 테마별로 기록하세요.
Micro Clean Architecture
모듈화와 계층 분리의 결합
기능 단위의 모듈화(Modular)와 내부 3계층 분리(Clean Architecture)를 동시에 적용
4대 핵심 모듈
APP(라우팅), Core(공통 로직/네트워크), Shared(디자인/UI), Features(도메인별 기능)로 역할 분리
Feature 내부 분리
각 도메인 모듈 내부는 Presentation, Domain, Data 계층으로 철저히 분리되어 의존성 최소화
Coding
Swift 스타일쉐어 가이드를 기반으로
팀원의 기존 스타일을 반영하였습니다.
Commit
예시 [Feat] #1 - 메인 UI 구현
Summary by CodeRabbit