Skip to content

Update README with gem naming conventions#479

Open
bovi wants to merge 3 commits intomruby:masterfrom
bovi:readme-dual-compatibility
Open

Update README with gem naming conventions#479
bovi wants to merge 3 commits intomruby:masterfrom
bovi:readme-dual-compatibility

Conversation

@bovi
Copy link
Member

@bovi bovi commented Feb 24, 2026

Clarify naming conventions for mruby specific gems and dual-compatible gems.

Clarify naming conventions for mruby specific gems and dual-compatible gems.
@bovi bovi requested a review from matz as a code owner February 24, 2026 12:36
@gemini-code-assist
Copy link

Summary of Changes

Hello @bovi, 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 enhances the clarity of gem naming conventions within the project's documentation. It provides more specific guidance on when to use the mruby- prefix and introduces a new rule for dual-compatible gems, ensuring that developers have precise instructions for naming their contributions.

Highlights

  • Gem Naming Conventions: Clarified the mruby- prefix rule, specifying it for mruby-specific gems.
  • Dual-Compatible Gems: Introduced a new guideline stating that no prefix is needed for gems compatible with both mruby and Rubygems.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

Changelog
  • README.md
    • Updated gem naming conventions to distinguish between mruby-specific and dual-compatible gems.
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 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

  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.

@bovi
Copy link
Member Author

bovi commented Feb 24, 2026

refers to #477 where it would make sense to support multi-compatibility gems for Rubygems and mruby

Copy link

@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 updates the README.md to clarify the naming conventions for mruby gems, distinguishing between those specific to mruby and those that are dual-compatible with Rubygems. This is a useful clarification. I have one minor suggestion to improve the wording for better readability.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant