Skip to content

[⚙️ Chore/227] 리드미 작성#228

Merged
heyudin merged 1 commit into
mainfrom
chore/227/readme
Jan 19, 2026
Merged

[⚙️ Chore/227] 리드미 작성#228
heyudin merged 1 commit into
mainfrom
chore/227/readme

Conversation

@heyudin
Copy link
Copy Markdown
Contributor

@heyudin heyudin commented Jan 19, 2026

✅ PR 체크리스트

  • 기능 정상 동작
  • 콘솔 에러 없음
  • UI 동작 및 반응형 레이아웃 확인

🔗 이슈 번호

✨ 작업한 내용

필요한 부분만 추려서 작성했습니다. 코멘트 부탁드려요

💁 리뷰 요청 / 코멘트

💡 참고사항

@heyudin heyudin self-assigned this Jan 19, 2026
@heyudin heyudin added the 📃 Docs 문서 작성 label Jan 19, 2026
@heyudin heyudin linked an issue Jan 19, 2026 that may be closed by this pull request
1 task
@gemini-code-assist
Copy link
Copy Markdown

Summary of Changes

Hello @yujin-fe, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

이 PR은 README.md 파일을 대대적으로 업데이트하여 GlobalNomad 프로젝트에 대한 포괄적이고 시각적으로 매력적인 개요를 제공합니다. 이 업데이트는 프로젝트의 목적, 사용된 기술 스택, 그리고 핵심 기능들을 시각적 예시와 함께 상세히 설명함으로써 새로운 기여자들과 이해관계자들이 프로젝트를 한눈에 이해하기 쉽게 만드는 것을 목표로 합니다.

Highlights

  • README.md 파일 전면 개편: 프로젝트의 목적, 기술 스택, 핵심 기능 및 페이지별 설명을 포함하도록 README.md 파일이 전면 개편되었습니다.
  • 기술 스택 시각화 강화: 기술 스택 섹션에 각 기술에 대한 배지가 추가되어 시각적인 명확성을 높였습니다.
  • 페이지별 기능 상세 설명 추가: 메인 페이지, 체험 상세 페이지, 내 정보, 내 예약 내역, 체험 관리, 체험 예약 현황 등 주요 페이지별 기능 설명과 함께 데스크톱 및 모바일 스크린샷이 추가되었습니다.
  • 개발 프로세스 관련 내용 정리: 기존의 브랜치 전략, 이슈/마일스톤, PR 규칙, 커밋 컨벤션 등 개발 프로세스 관련 내용은 제거되고 프로젝트 기능 설명에 집중하도록 변경되었습니다.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

@github-actions
Copy link
Copy Markdown

Copy link
Copy Markdown

@gemini-code-assist gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

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

Code Review

README.md 파일을 프로젝트를 소개하는 내용으로 대대적으로 업데이트하셨네요. 기술 스택, 주요 기능, 페이지별 스크린샷 등을 포함하여 프로젝트를 이해하기 쉽게 잘 정리해주셨습니다. 전반적으로 훌륭한 업데이트입니다! 몇 가지 사소한 부분들을 개선하면 더 완성도 높은 README가 될 것 같아 아래에 몇 가지 제안을 남깁니다. 주로 웹 접근성 및 문장의 띄어쓰기 관련 내용입니다.

Comment thread README.md

| Desktop | Mobile |
| ------------------------------------------ | ------------------------------------------ |
| <img src="docs/main-pc.png" width="400" /> | <img src="docs/main-mb.png" width="180" /> |
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

medium

웹 접근성을 위해 <img> 태그에 alt 속성을 추가하는 것이 좋습니다. 스크린 리더 사용자에게 이미지에 대한 정보를 제공할 수 있어 유용합니다.

Suggested change
| <img src="docs/main-pc.png" width="400" /> | <img src="docs/main-mb.png" width="180" /> |
| <img src="docs/main-pc.png" width="400" alt="메인페이지 데스크탑 화면" /> | <img src="docs/main-mb.png" width="180" alt="메인페이지 모바일 화면" /> |

Comment thread README.md
6. Merge → 브랜치 삭제
| Desktop | Mobile |
| -------------------------------------------- | -------------------------------------------- |
| <img src="docs/detail-pc.png" width="400" /> | <img src="docs/detail-mb.png" width="200" /> |
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

medium

웹 접근성을 위해 <img> 태그에 alt 속성을 추가하는 것이 좋습니다. 스크린 리더 사용자에게 이미지에 대한 정보를 제공할 수 있어 유용합니다.

Suggested change
| <img src="docs/detail-pc.png" width="400" /> | <img src="docs/detail-mb.png" width="200" /> |
| <img src="docs/detail-pc.png" width="400" alt="체험 상세 페이지 데스크탑 화면" /> | <img src="docs/detail-mb.png" width="200" alt="체험 상세 페이지 모바일 화면" /> |

Comment thread README.md

| Desktop | Mobile |
| -------------------------------------------- | -------------------------------------------- |
| <img src="docs/mypage-pc.png" width="400" /> | <img src="docs/mypage-mb.png" width="200" /> |
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

medium

웹 접근성을 위해 <img> 태그에 alt 속성을 추가하는 것이 좋습니다. 스크린 리더 사용자에게 이미지에 대한 정보를 제공할 수 있어 유용합니다.

Suggested change
| <img src="docs/mypage-pc.png" width="400" /> | <img src="docs/mypage-mb.png" width="200" /> |
| <img src="docs/mypage-pc.png" width="400" alt="내 정보 페이지 데스크탑 화면" /> | <img src="docs/mypage-mb.png" width="200" alt="내 정보 페이지 모바일 화면" /> |

Comment thread README.md
### 코드 리뷰 기준
| Desktop | Mobile |
| --------------------------------------------------- | --------------------------------------------------- |
| <img src="docs/myreservation-pc.png" width="400" /> | <img src="docs/myreservation-mb.png" width="200" /> |
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

medium

웹 접근성을 위해 <img> 태그에 alt 속성을 추가하는 것이 좋습니다. 스크린 리더 사용자에게 이미지에 대한 정보를 제공할 수 있어 유용합니다.

Suggested change
| <img src="docs/myreservation-pc.png" width="400" /> | <img src="docs/myreservation-mb.png" width="200" /> |
| <img src="docs/myreservation-pc.png" width="400" alt="내 예약 내역 페이지 데스크탑 화면" /> | <img src="docs/myreservation-mb.png" width="200" alt="내 예약 내역 페이지 모바일 화면" /> |

Comment thread README.md
### 체험 관리

```
유저가 등록한 체험을 조회가능하며 체험 등록, 수정, 삭제가 가능합니다.
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

medium

가독성을 높이기 위해 '조회가능하며'를 '조회 가능하며'로 띄어쓰기를 수정하는 것을 제안합니다.

Suggested change
유저가 등록한 체험을 조회가능하며 체험 등록, 수정, 삭제가 가능합니다.
유저가 등록한 체험을 조회 가능하며 체험 등록, 수정, 삭제가 가능합니다.

Comment thread README.md
- AI 코드리뷰 활용 (Gemini)
| Desktop | Mobile |
| -------------------------------------------------- | -------------------------------------------------- |
| <img src="docs/myactivities-pc.png" width="400" /> | <img src="docs/myactivities-mb.png" width="200" /> |
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

medium

웹 접근성을 위해 <img> 태그에 alt 속성을 추가하는 것이 좋습니다. 스크린 리더 사용자에게 이미지에 대한 정보를 제공할 수 있어 유용합니다.

Suggested change
| <img src="docs/myactivities-pc.png" width="400" /> | <img src="docs/myactivities-mb.png" width="200" /> |
| <img src="docs/myactivities-pc.png" width="400" alt="체험 관리 페이지 데스크탑 화면" /> | <img src="docs/myactivities-mb.png" width="200" alt="체험 관리 페이지 모바일 화면" /> |

Comment thread README.md
♻️ Refactor
⚙️ Chore
📄 Docs
등록한 체험에 대한 예약 현황을 체험별로 확인할 수 있으며, 신청된 예약을 승인, 거절 할 수 있습니다.
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

medium

올바른 띄어쓰기인 '거절할 수 있습니다'로 수정하는 것을 제안합니다.

Suggested change
등록한 체험에 대한 예약 현황을 체험별로 확인할 수 있으며, 신청된 예약을 승인, 거절 할 수 있습니다.
등록한 체험에 대한 예약 현황을 체험별로 확인할 수 있으며, 신청된 예약을 승인, 거절할 수 있습니다.

Comment thread README.md
TSDoc: 추가 설명
| Desktop | Mobile |
| --------------------------------------------------------------- | --------------------------------------------------------------- |
| <img src="docs/myactivities-reservations-pc.png" width="400" /> | <img src="docs/myactivities-reservations-mb.png" width="200" /> |
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

medium

웹 접근성을 위해 <img> 태그에 alt 속성을 추가하는 것이 좋습니다. 스크린 리더 사용자에게 이미지에 대한 정보를 제공할 수 있어 유용합니다.

Suggested change
| <img src="docs/myactivities-reservations-pc.png" width="400" /> | <img src="docs/myactivities-reservations-mb.png" width="200" /> |
| <img src="docs/myactivities-reservations-pc.png" width="400" alt="체험 예약 현황 데스크탑 화면" /> | <img src="docs/myactivities-reservations-mb.png" width="200" alt="체험 예약 현황 모바일 화면" /> |

Copy link
Copy Markdown
Contributor

@eunji0124 eunji0124 left a comment

Choose a reason for hiding this comment

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

확인했습니다

@heyudin heyudin merged commit 4f26e5f into main Jan 19, 2026
1 check passed
@heyudin heyudin deleted the chore/227/readme branch January 19, 2026 06:04
heyudin added a commit to heyudin/global-nomad that referenced this pull request Jan 19, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

📃 Docs 문서 작성

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[⚙️ Chore] 리드미 작성

2 participants