Skip to content

Update README with gem naming conventions #479

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.

Sign up for GitHub

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

Open
bovi wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Update README with gem naming conventions #479

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
71c3c11
Update README with gem naming conventions
bovi Feb 24, 2026
054460a
Clarify naming convention for dual-compatible gems
bovi Feb 24, 2026
7b62de6
Fix formatting of README.md for dual-compatible gems
bovi Feb 24, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,5 +31,7 @@ When creating a new GEM please consider:
- the name should express the functionality of the GEM clearly
- words should be separated by using dash (-)
- don't use `under_score` and `CamelCase`
- prefix should be `mruby-`
- prefix should be `mruby-` for mruby specific gems
- for gems compatible with both mruby and Rubygems (`dual-compatible gems`),
no prefix is needed
- if it's an executable, prefix should be _mruby-bin-_