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

Add a file that explains default gems #7

Closed
wants to merge 1 commit into from

Conversation

janlelis
Copy link
Contributor

@janlelis janlelis commented Jan 2, 2019

Based on the current README and the discussion on the ruby bug tracker I have created this documentation file, which could serve as a template for other default gems.

What do you think about this approauch? What else could be in there?

This adds documentation about the purpose of default gems and how to use (or don't use) them
@stomar
Copy link
Contributor

stomar commented Jan 3, 2019

IMO the essential information should be directly included in a subsection of the README, not a separate file.

@yuki24
Copy link
Member

yuki24 commented Jan 3, 2019

I second @stomar. When it's in a separate file it's a bit harder to notice.

@marcandre
Copy link
Member

Thanks for the PR. I couldn't find much differences with the existing README.

The stdgems.org project looks cool but feels like too much information for most people imo. I'd rather keep it simple in the Changelog, at least for now.

I'm closing this, feel free to create a PR with direct changes to the README for improvements.

@marcandre marcandre closed this Jan 18, 2019
@stomar
Copy link
Contributor

stomar commented Jan 19, 2019

Afterthought regarding finding out the used version: if this would be included in the README for this or all default gems, I personally would favor an „offline“ way to do it, like gem list, or a VERSION constant, or similar.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants