Skip to content

누락 TSDoc 작성#1057

Merged
DevHyungJun merged 7 commits into
developfrom
docs/TSDoc
May 18, 2026
Merged

누락 TSDoc 작성#1057
DevHyungJun merged 7 commits into
developfrom
docs/TSDoc

Conversation

@DevHyungJun
Copy link
Copy Markdown
Contributor

@DevHyungJun DevHyungJun commented May 17, 2026

Pull Request

작업 내용

  • 전역 constants 폴더 내부에 누락되어있던 TSDoc을 작성했습니다.

체크리스트

  • 기능이 정상 동작하는지 확인
  • 로컬 빌드/스토리북/테스트 통과
  • 불필요한 코드/주석 제거

@DevHyungJun DevHyungJun added 📄 docs README, 주석, 개발 문서, 위키 관련 작업 D-1 24시간 이내에 처리가 필요합니다. labels May 17, 2026
@auto-assign auto-assign Bot requested review from suhyeon0111 and wlrnjs May 17, 2026 14:46
@vercel
Copy link
Copy Markdown

vercel Bot commented May 17, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
finditem Ready Ready Preview, Comment May 18, 2026 4:37am

@gemini-code-assist
Copy link
Copy Markdown
Contributor

Summary of Changes

Hello, 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!

This pull request focuses on improving the developer experience by adding detailed TSDoc documentation to global constants. By providing context for these constants, the changes help clarify their usage in authentication flows, geolocation sessions, and environment-specific configurations. Additionally, a redundant file was removed to streamline the constants structure.

Highlights

  • TSDoc Documentation: Added comprehensive TSDoc comments to various constants files in the src/constants directory to improve code maintainability and IDE support.
  • Code Cleanup: Removed the redundant src/constants/DEFAULT_LAT_LNG.ts file, consolidating exports into src/constants/DEFAULT_MAP_DATA.ts.
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 the 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 counterproductive. 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.


Constants defined with care and grace, Documented well in every place. No more guessing what they mean, With TSDoc tags, the code is clean.

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

github-actions Bot commented May 17, 2026

Jest Test Results

1 373 tests   1 373 ✅  1m 26s ⏱️
  247 suites      0 💤
    1 files        0 ❌

Results for commit b15dbbe.

♻️ This comment has been updated with latest results.

@github-actions
Copy link
Copy Markdown

github-actions Bot commented May 17, 2026

Playwright Test Results

124 tests   124 ✅  1m 23s ⏱️
 22 suites    0 💤
  1 files      0 ❌

Results for commit b15dbbe.

♻️ This comment has been updated with latest results.

Copy link
Copy Markdown
Contributor

@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

This pull request adds JSDoc documentation and author tags to several constant files, including authentication events, map data, session keys, and release hostnames. The reviewer suggests improving the documentation by consolidating redundant JSDoc blocks and removing the @author tags, as authorship is already tracked via Git history. Additionally, the reviewer noted that centralizing hostnames in a constant file follows the project's recommended practices.

Comment thread src/constants/AUTH_EVENTS.ts Outdated
Comment thread src/constants/DEFAULT_MAP_DATA.ts
Comment thread src/constants/GEO_SESSION.ts
Comment thread src/constants/RELEASE_HOSTNAME.ts Outdated
suhyeon0111
suhyeon0111 previously approved these changes May 17, 2026
Copy link
Copy Markdown
Contributor

@suhyeon0111 suhyeon0111 left a comment

Choose a reason for hiding this comment

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

수고하셨습니다!

Comment thread src/constants/AUTH_EVENTS.ts Outdated
@DevHyungJun DevHyungJun merged commit e74020b into develop May 18, 2026
8 checks passed
@DevHyungJun DevHyungJun deleted the docs/TSDoc branch May 18, 2026 04:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

D-1 24시간 이내에 처리가 필요합니다. 📄 docs README, 주석, 개발 문서, 위키 관련 작업

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants