我們建議在寶石名稱中使用「_」和「-」

以下是我們建議的寶石命名範例

寶石名稱	Require 陳述式	主要類別或模組
ruby_parser	require 'ruby_parser'	RubyParser
rdoc-data	require 'rdoc/data'	RDoc::Data
net-http-persistent	require 'net/http/persistent'	Net::HTTP::Persistent
net-http-digest_auth	require 'net/http/digest_auth'	Net::HTTP::DigestAuth

這些建議的主要目標是提供使用者一些線索，說明如何要求您的寶石中的檔案。遵循這些慣例，Bundler 也可以在沒有額外設定的情況下，要求您的寶石。

如果您在 rubygems.org 上發佈寶石，如果名稱有爭議、違反智慧財產權，或寶石的內容符合這些標準，則可能會被移除。您可以透過電子郵件將此類寶石報告給 support@rubygems.org。

對多個單字使用底線

如果類別或模組有多個單字，請使用底線將它們分開。這與使用者將要求的檔案相符，讓使用者更容易開始使用您的寶石。

對擴充功能使用破折號

如果您要新增其他寶石的功能，請使用破折號。這通常對應於 require 陳述式中的 /（因此也對應於您的寶石目錄結構）和主類別或模組名稱中的 ::。

適當地混合底線和破折號

如果您的類別或模組有多個單字，而且您也新增其他寶石的功能，請遵循以上兩項規則。例如，net-http-digest_auth 會將 HTTP 摘要驗證 新增到 net/http。使用者將 require 'net/http/digest_auth' 來使用擴充功能（在類別 Net::HTTP::DigestAuth 中）。

不要使用大寫字母

OS X 和 Windows 預設為不區分大小寫的檔案系統。使用者可能會錯誤地使用大寫字母要求寶石中的檔案，如果他們將其移至非 Windows 或 OS X 系統，這將無法移植。雖然這大多是新手會犯的錯誤，但我們不需要讓他們感到更困惑。

鳴謝

本指南擴充自 Eric Hodel 的 如何命名寶石。