-
Notifications
You must be signed in to change notification settings - Fork 21
📝 Update conventional gitmoji web url #172
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
base: master
Are you sure you want to change the base?
📝 Update conventional gitmoji web url #172
Conversation
Summary of ChangesHello @glazrtom, 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 addresses an issue by updating the URL for the 'Conventional Gitmoji' resource. The change ensures that all references, both in documentation and the plugin's internal configuration, point to the correct and active GitHub Pages hosted version of the Conventional Gitmoji specification, improving user experience and maintaining data integrity. 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 a dead link for the Conventional Gitmoji website across documentation and source code. The change is straightforward and effective. I've added one suggestion to improve maintainability in the Kotlin source file by using constants for URLs, following a pattern already present in the file. Overall, this is a good contribution.
| override val jsonUrl: String = "https://raw.githubusercontent.com/glazrtom/conventional-gitmoji-config/refs/heads/master/gitmojis.json" | ||
| override val localizationUrl: String = "https://raw.githubusercontent.com/glazrtom/conventional-gitmoji-config/refs/heads/master/localizations/gitmojis-{locale}.yaml" | ||
| override val tooltipUrl: String = "https://conventional-gitmoji.web.app/" | ||
| override val tooltipUrl: String = "https://ackeecz.github.io/conventional-gitmoji/" |
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.
While this change is correct, for better maintainability and consistency with other parts of this file (like the Custom object), consider defining this URL and the other related URLs (jsonUrl, localizationUrl) as const val in a companion object within ConventionalGitmoji. This would centralize the URLs and make them easier to manage.
|
The previous URL https://conventional-gitmoji.web.app/ is more understandable than the new url on github page. |
|
That would require owning a custom domain. The current one is the default domain provided by GitHub. The previous domain I used was actually intended only for development or non-production use, which I wasn’t aware of at the time. I think using this domain with a path is effectively the same in terms of clarity. Since users only click the link from within the plugin, they don’t need to read or interpret the URL at all. |
As asked in #170 here is the updated version with github pages. Thanks!