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.

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

Recommend license attribute in gemspec #713

Merged
merged 4 commits into from
Nov 21, 2013

Conversation

bf4
Copy link
Contributor

@bf4 bf4 commented Nov 18, 2013

Per discussion in rubygems/guides#67

  1. Adds a license attribute to the example gemspec
  2. Adds categories for Required and Optional gemspec attributes sections
  3. Add 'Recommended' category for license/licenses within the Optional section
  4. Add documentation to license, re: github chooser and legal importance
  5. Add recommendation to warning (and test)

@drbrain I built the spec guide and it looked fine. RUBYGEMS_DIR=$HOME/repos/forked/rubygems rake spec_guide --trace

@drbrain
Copy link
Member

drbrain commented Nov 18, 2013

Overall this looks good!

I would comment directly on the lines, but I am on the bus and desktop view typing is painfully slow.

Can you remove the empty :category: lines? They aren't needed because category only applies to methods and attributes.

Does the updated WARNING text fit on one line with 80 columns? I would prefer the URL to stand alone so it's easier to cut and paste.

@@ -331,6 +333,7 @@ def files

######################################################################
# :section: Optional gemspec attributes
# :category:
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Per @drbrain, remove

@bf4
Copy link
Contributor Author

bf4 commented Nov 19, 2013

@drbrain updated, also updated the related PR in rubygems/guides#67 (not sure what your usual process is)

bf4 added a commit to bf4/guides-1 that referenced this pull request Nov 19, 2013
per @drbrain

Also, removed unnecessary :category: tags
drbrain added a commit that referenced this pull request Nov 21, 2013
Add recommend license attribute for gemspec
@drbrain drbrain merged commit 56db8be into rubygems:master Nov 21, 2013
drbrain added a commit that referenced this pull request Nov 21, 2013
@bf4
Copy link
Contributor Author

bf4 commented Nov 21, 2013

Great! It looks like the spec page in the guides should be manually regenerated?

@drbrain
Copy link
Member

drbrain commented Nov 21, 2013

That will happen automatically with the next release. I'm not sure if the changes to specification are cosmetic only, so I'd like to wait.

This was referenced Nov 26, 2013
@bf4
Copy link
Contributor Author

bf4 commented Dec 3, 2013

@drbrain Sorry, forgot about the github feature of linking issues... will fix

@drbrain
Copy link
Member

drbrain commented Dec 3, 2013

No problem! If github sends emails for these I don't recall if I noticed

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.

None yet

2 participants