Skip to content
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

Jump to bottom

[Documentation] Update bundler.io "How to create a Ruby gem with Bundler" part #1067

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

[Documentation] Update bundler.io "How to create a Ruby gem with Bundler" part #1067

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
3ffdc88
Updated with tnir's comment
Mth0158 Jul 19, 2022
658a7c8
Merge branch 'master' of github.com:Mth0158/bundler-site
Mth0158 Jan 5, 2023
e00127f
[Documentation] Update creating_gem.en.html.md
Mth0158 Jan 5, 2023
965afea
Add olleolleolle suggestions
Mth0158 Jan 5, 2023
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
6 changes: 6 additions & 0 deletions source/localizable/guides/creating_gem.en.html.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,12 @@ extension and the _.bundle_ directory.
* **foodie.gemspec**: The Gem Specification file. This is
where we provide information for Rubygems' consumption such as the name, description and homepage
of our gem. This is also where we specify the dependencies our gem needs to run.
* Fields to complete:
* `description (optional):` A long description of your gem. The description should be more detailed than the summary but not excessively long. A few paragraphs is a recommended length with no examples or formatting.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* `description (optional):` A long description of your gem. The description should be more detailed than the summary but not excessively long. A few paragraphs is a recommended length with no examples or formatting.
* `description` (optional): A long description of your gem. The description should be more detailed than the summary but not excessively long. A few paragraphs is a recommended length with no examples or formatting.

* `homepage:` The URL of your gem's home page, it can be the URL of its website or public repo.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Minor: Place the colon outside of the formatting backticks.

* `metadata["allowed_push_host"]:` The field allows you to restrict gem pushes to a single host. If you are not running your own gem server you should comment this line, otherwise you will not be able to push your gem to rubygems.org.
* `metadata["source_code_uri"]:` The URL of your gem's public repo.
* `metadata["changelog_uri"]:` The URL of your gem's CHANGELOG.

* **lib/foodie.rb**: The main file to define our gem's
code. This is the file that will be required by Bundler (or any similarly smart system) when our
Expand Down