[DOCS] README 파일 추가 #163
[DOCS] README 파일 추가 #163
Conversation
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Summary of Changes
Hello @chanwonlee, 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!
이 풀 리퀘스트는 프로젝트의 문서화를 크게 개선하는 것을 목표로 합니다. 새로 추가된 README.md 파일은 프로젝트의 목적, 사용된 기술, 시스템 아키텍처, 핵심 기능 및 주요 API 엔드포인트에 대한 포괄적인 정보를 제공하여, 새로운 기여자나 이해 관계자들이 프로젝트를 빠르게 이해하고 참여할 수 있도록 돕습니다.
Highlights
- README 파일 추가: 프로젝트의 전반적인 개요, 기술 스택, 아키텍처 다이어그램, 주요 기능 설명 및 핵심 API 엔드포인트 목록을 포함하는 상세한 README.md 파일이 새로 추가되었습니다.
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 in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| 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 issue 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
-
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. ↩
Jimin730
left a comment
Jimin730
left a comment
There was a problem hiding this comment.
Readme 파일 꼼꼼하게 작성해주셔서 감사합니다 !
고생하셨습니다! 👍
관련 Issue (필수)
주요 변경 사항 (필수)
리뷰어 참고 사항
없음
추가 정보
없음
PR 작성 체크리스트 (필수)