-
Notifications
You must be signed in to change notification settings - Fork 0
docs: update readme.md #2
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Summary of Changes
Hello @sezeme, 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 significantly updates the README.md to provide a much more comprehensive and user-friendly guide for the Notion-GitHub integration. The changes aim to improve user onboarding by clearly documenting the system's automated features, providing explicit setup instructions, and offering a new troubleshooting section, thereby enhancing the overall usability and maintainability of the project's documentation.
Highlights
- Enhanced Feature Explanation: The
README.mdnow includes a detailed 'Feature Guide' section, clearly outlining the automated functionalities such as page detection based on branch names, dynamic property status updates (e.g., 'In Progress' on PR open, 'Completed' on merge), and automatic integration of PR links into Notion. - Improved Setup Clarity: Setup instructions for both Notion and GitHub secrets have been significantly expanded and clarified. This includes explicit requirements for Notion property names ('ID', 'GitHub Pull Requests'), their types, and a more precise example for extracting the
NOTION_DATABASE_IDfrom a Notion URL. - New Troubleshooting Guide: A dedicated 'Troubleshooting' section has been added to help users diagnose common issues, advising them to verify specific Notion property names ('생성 일시', '상태') and values ('진행 중', '완료'), and to cross-reference with the
scripts/sync-notion.tscode.
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 or fill out our survey to provide feedback.
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. ↩
There was a problem hiding this 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 significantly improves the README.md file by adding comprehensive documentation on the project's features, setup instructions, and troubleshooting tips. The new content is well-structured and accurately reflects the script's functionality. I've included a couple of minor suggestions to enhance formatting consistency. Overall, this is an excellent update that greatly improves the project's usability.
| @@ -1,14 +1,47 @@ | |||
| # github-actions | |||
| 노션 - 깃허브 연동을 위한 자동화 레포지토리 | |||
| # org-actions-template | |||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This line, along with several others in the file, has trailing whitespace. While this doesn't break rendering on most markdown viewers, it's a good practice to remove trailing spaces for consistency and to avoid potential issues in stricter environments or with certain tools.
This also applies to lines 7, 19, 20, 21, 22, 24, 25, 26, 27, 31, and 34.
| # org-actions-template | |
| # org-actions-template |
|
|
||
|
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
No description provided.