Skip to content

docs: 프로젝트 리드미 업데이트#301

Merged
LeeHanEum merged 1 commit intodevelopfrom
docs/readme
Dec 23, 2025
Merged

docs: 프로젝트 리드미 업데이트#301
LeeHanEum merged 1 commit intodevelopfrom
docs/readme

Conversation

@LeeHanEum
Copy link
Copy Markdown
Member

Summary

프로젝트 리드미 업데이트

Tasks

  • 2기 개발자 추가

To Reviewer

(없을 경우 삭제) 더 전달할 내용이 있다면 여기에 작성해주세요.

Screenshot

(없을 경우 삭제) 작업한 내용에 대한 스크린샷을 첨부해주세요.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Dec 22, 2025

Walkthrough

README.md의 기여자(contributors) 섹션을 기존 3열 서버 구조에서 새로운 2단계 개발자 명단("2nd Developers", "1st Developers")으로 재구성. 아바타 이미지, 이름, 역할 및 날짜 정보를 포함한 테이블 형식 조정. 시스템 아키텍처 및 기타 섹션은 변경 없음.

Changes

변경 사항 파일
기여자 섹션 업데이트
2단계 개발자 명단 구조로 전환, 새로운 아바타 이미지 및 개발자 정보 추가, 테이블 헤더 및 형식 조정
README.md

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

  • README.md 기여자 섹션의 형식 및 콘텐츠 변경으로 구성된 문서 전용 수정사항
  • 새로운 개발자 정보의 정확성 확인 필요

Possibly related PRs

  • PR #180: README 초기 추가 및 기여자 섹션 구성—원본 기여자 블록을 추가한 PR이며, 현 PR이 해당 기여자 섹션을 재구성 및 업데이트

Suggested reviewers

  • LeeShinHaeng

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed PR 제목이 변경 사항과 일치합니다. README.md 파일의 개발자 명단 업데이트 작업을 명확하게 설명하고 있습니다.
Description check ✅ Passed PR 설명이 변경 사항과 관련이 있습니다. '2기 개발자 추가'라는 작업 항목이 요약 내용과 일치합니다.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch docs/readme

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

Test Coverage Report

Overall Project 81.16% 🍏

There is no coverage information present for the Files changed

@codecov
Copy link
Copy Markdown

codecov bot commented Dec 22, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.

Impacted file tree graph

@@            Coverage Diff             @@
##             develop     #301   +/-   ##
==========================================
  Coverage      87.50%   87.50%           
  Complexity        65       65           
==========================================
  Files             22       22           
  Lines            256      256           
  Branches          15       15           
==========================================
  Hits             224      224           
  Misses            19       19           
  Partials          13       13           

Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 5ba321f...eec6a13. Read the comment docs.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Copy link
Copy Markdown
Contributor

@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: 2

📜 Review details

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 5ba321f and eec6a13.

📒 Files selected for processing (1)
  • README.md
🧰 Additional context used
🪛 markdownlint-cli2 (0.18.1)
README.md

18-18: Images should have alternate text (alt text)

(MD045, no-alt-text)


18-18: Images should have alternate text (alt text)

(MD045, no-alt-text)


18-18: Images should have alternate text (alt text)

(MD045, no-alt-text)


18-18: Tables should be surrounded by blank lines

(MD058, blanks-around-tables)


24-24: Images should have alternate text (alt text)

(MD045, no-alt-text)


24-24: Images should have alternate text (alt text)

(MD045, no-alt-text)


24-24: Images should have alternate text (alt text)

(MD045, no-alt-text)


24-24: Tables should be surrounded by blank lines

(MD058, blanks-around-tables)

Comment on lines +17 to +21
### 2nd Developers <sub><sup>(2025.07 - present)</sup></sub>
| ![](https://github.com/JangYeongHu.png?size=100) | <img src="https://github.com/dkdltm221.png" width="100" height="100" /> | ![](https://github.com/LeeHanEum.png?size=100) |
|:------------------------------------------------:|:----------------------------------------------:|:-------------------------------------------------:|
| **장영후 👑** | **주윤빈** | **이한음** |

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.

⚠️ Potential issue | 🟡 Minor

마크다운 접근성 기준 준수: alt text 추가 및 테이블 구분 빈 줄 추가 필요

정적 분석 결과, 다음 두 가지 개선이 필요합니다:

  1. 이미지 alt text 추가 (MD045): 라인 18의 모든 이미지에 alt text를 추가하여 접근성을 높이세요.
  2. 테이블 앞 빈 줄 추가 (MD058): 라인 17의 제목과 라인 18의 테이블 사이에 빈 줄을 추가하세요.
🔎 제안된 수정사항
 이 레포지토리는 서버 API 개발을 담당하고 있으며, [프론트엔드 레포지토리](https://github.com/kgu-developers/aics-client)도 함께 공개되어 있습니다.

 ## 👨🏻‍💻 Contributors

 ### 2nd Developers <sub><sup>(2025.07 - present)</sup></sub>

-| ![](https://github.com/JangYeongHu.png?size=100) | <img src="https://github.com/dkdltm221.png" width="100" height="100" /> | ![](https://github.com/LeeHanEum.png?size=100) |
+| ![장영후](https://github.com/JangYeongHu.png?size=100) | ![주윤빈](https://github.com/dkdltm221.png?size=100) | ![이한음](https://github.com/LeeHanEum.png?size=100) |
 |:------------------------------------------------:|:----------------------------------------------:|:-------------------------------------------------:|
 |                    **장영후 👑**                    |                    **주윤빈**                     |                      **이한음**                      |
🧰 Tools
🪛 markdownlint-cli2 (0.18.1)

18-18: Images should have alternate text (alt text)

(MD045, no-alt-text)


18-18: Images should have alternate text (alt text)

(MD045, no-alt-text)


18-18: Images should have alternate text (alt text)

(MD045, no-alt-text)


18-18: Tables should be surrounded by blank lines

(MD058, blanks-around-tables)

🤖 Prompt for AI Agents
In README.md around lines 17–21, the markdown fails accessibility checks: add
meaningful alt text for each image tag on line 18 (replace empty or missing alt
attributes with brief descriptive text for each person) and insert a blank line
between the "### 2nd Developers..." heading (line 17) and the table (line 18) so
the table is properly separated from the heading; ensure the table row/column
markup remains unchanged aside from the alt attributes and the added blank line.

Comment on lines +23 to +26
### 1st Developers <sub><sup>(2024.10 - 2025.06)</sup></sub>
| ![](https://github.com/LeeHanEum.png?size=100) | ![](https://github.com/minjo-on.png?size=100) | ![](https://github.com/LeeShinHaeng.png?size=100) |
|:----------------------------------------------:|:---------------------------------------------:|:-------------------------------------------------:|
| **이한음 👑** | **박민준** | **이신행** |
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.

⚠️ Potential issue | 🟡 Minor

이미지 alt text 추가 필요 (MD045)

라인 24의 이미지들에 alt text를 추가하여 접근성을 높이세요. 1st Developers 섹션의 테이블 구분 빈 줄은 올바르게 배치되어 있습니다.

🔎 제안된 수정사항
 ### 1st Developers <sub><sup>(2024.10 - 2025.06)</sup></sub>
-| ![](https://github.com/LeeHanEum.png?size=100) | ![](https://github.com/minjo-on.png?size=100) | ![](https://github.com/LeeShinHaeng.png?size=100) |
+| ![이한음](https://github.com/LeeHanEum.png?size=100) | ![박민준](https://github.com/minjo-on.png?size=100) | ![이신행](https://github.com/LeeShinHaeng.png?size=100) |
 |:----------------------------------------------:|:---------------------------------------------:|:-------------------------------------------------:|
 |                   **이한음 👑**                   |                    **박민준**                    |                      **이신행**                      |
🧰 Tools
🪛 markdownlint-cli2 (0.18.1)

24-24: Images should have alternate text (alt text)

(MD045, no-alt-text)


24-24: Images should have alternate text (alt text)

(MD045, no-alt-text)


24-24: Images should have alternate text (alt text)

(MD045, no-alt-text)


24-24: Tables should be surrounded by blank lines

(MD058, blanks-around-tables)

🤖 Prompt for AI Agents
In README.md around lines 23 to 26, the markdown image elements lack alt text
(MD045); update each image tag in the table to include descriptive alt text
(e.g., ![LeeHanEum avatar](https://github.com/LeeHanEum.png?size=100)),
replacing the current ![](...) forms for all three images so they provide
meaningful alt attributes and improve accessibility.

Copy link
Copy Markdown
Contributor

@JangYeongHu JangYeongHu left a comment

Choose a reason for hiding this comment

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

LGTM!

Copy link
Copy Markdown
Contributor

@dkdltm221 dkdltm221 left a comment

Choose a reason for hiding this comment

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

LGTM 👍 👍

@LeeHanEum LeeHanEum merged commit 890ad2b into develop Dec 23, 2025
5 checks passed
@LeeHanEum LeeHanEum deleted the docs/readme branch December 23, 2025 13:33
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.

3 participants