-
Notifications
You must be signed in to change notification settings - Fork 0
fix(readme): Update example GitHub repository URL #18
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
Summary of ChangesHello @ioncakephper, 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 provides a minor but important fix to the Highlights
Using Gemini Code AssistThe 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
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 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
|
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 correctly updates the example GitHub repository URL in the README.md file. My review includes suggestions to further enhance the documentation's clarity and user-friendliness by removing the .git suffix from the example URLs. This minor change makes the links cleaner and directly viewable in a web browser.
|
|
||
| // Scenario 3: Generate descriptions for a remote GitHub repository | ||
| const remoteRepoPath = 'https://github.com/IonGireada/repo-description.git'; | ||
| const remoteRepoPath = 'https://github.com/ioncakephper/repo-description.git'; |
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.
For better readability and user experience, consider using the repository's web URL (without the .git suffix). The tool and git clone both handle this format correctly, and it provides a cleaner, browser-friendly link for users who might want to view the repository online.
| const remoteRepoPath = 'https://github.com/ioncakephper/repo-description.git'; | |
| const remoteRepoPath = 'https://github.com/ioncakephper/repo-description'; |
|
|
||
| # Generate Markdown descriptions for a remote GitHub repository, clone it to a specific directory, and include a summary and table format | ||
| repo-describer https://github.com/IonGireada/repo-description.git -c ./cloned_repos -o repo-descriptions.md -f markdown --summary --table | ||
| repo-describer https://github.com/ioncakephper/repo-description.git -c ./cloned_repos -o repo-descriptions.md -f markdown --summary --table |
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.
For consistency and improved user experience, I recommend using the repository's web URL without the .git suffix here as well. This makes the URL easier to copy and paste into a browser for viewing.
| repo-describer https://github.com/ioncakephper/repo-description.git -c ./cloned_repos -o repo-descriptions.md -f markdown --summary --table | |
| repo-describer https://github.com/ioncakephper/repo-description -c ./cloned_repos -o repo-descriptions.md -f markdown --summary --table |
No description provided.