`bundle gem` template improvement (dependency example)

[fwolfst]

Bundlers (e.g. 1.16.2) template for a new gems gemspec is helpful to get started.

From a user point of view I would like to include a commented-out example of how to get dependencies registered (spec.add_dependency 'example-gem', '~> 1.0').

If I get heads up, I will create a PR.

[colby-swandale]

I'm on the fence about this. I don't think we should introduce examples of things as comments into the template, but i understand users may be looking for information/examples about making a new gem.

How does linking the How to Create a RubyGem guide from the Bundler docs instead sound?

Something like:

# For more information and examples about making a new gem, checkout our 
# guide at: https://bundler.io/v1.17/guides/creating_gem.html

[colby-swandale]

ping @fwolfst

[fwolfst]

I am pretty pragmatic here.
When I edit the created .gemspec I usually already know exactly what I want to do (edit descritption, remove the block about rubygems-pushing and add dependencies).

It became a pattern for me to yank a add_development_dependency line, paste it and modify it (YPwllllldtd in vim ...). That is actually how I came to this issue, thinking about better vim skills in the first place and then realizing that an example line that did not include "development" would be great.

I see the link to documentation not being a bad idea, but my intention was really just to fix the scenario where I want to jump in the gemspec, do my stuff and be out of it as quickly as possible and start writing the other code.

[deivid-rodriguez]

Actually we moved all the add_development_dependency lines and moved them to the Gemfile, so your vim trick is not going to work anymore. :/

I don't have a strong opinion here. I'm fine with both adding an example, a link to docs, or both. Or none.

@colby-swandale Still on the fence?

[deivid-rodriguez]

Ok @fwolfst, if you're still interested, would you mind creating a PR adding both a commented out dependency example and a link to the documentation for more information?