setup-ruby icon indicating copy to clipboard operation
setup-ruby copied to clipboard

README.md updates & 'use ruby/setup-ruby@v1

Open MSP-Greg opened this issue 3 years ago • 4 comments

I thought a note about the 'available Ruby version' issue would be helpful at the top of the document.

It does overlap with the VERSIONING paragraph...

MSP-Greg avatar Aug 10 '22 15:08 MSP-Greg

People should already be aware of this via the issue template (https://raw.githubusercontent.com/ruby/setup-ruby/master/.github/ISSUE_TEMPLATE/bug_report.md). I think this will not help more, people who don't know how to read the template when filing an issue probably can't read READMEs either. For such people, I think it is fair to close with just a link to https://github.com/ruby/setup-ruby#versioning and nothing else.

Homebrew goes further and says it bans people not respecting the template, I think that's maybe too much.

eregon avatar Aug 10 '22 15:08 eregon

Maybe we should use an Issue Form template like https://github.com/Homebrew/brew/blob/master/.github/ISSUE_TEMPLATE/bug.yml

eregon avatar Aug 10 '22 15:08 eregon

Having the info right at the top so one doesn't even need to scroll both here and in the Marketplace will possibly mean people don't need to see the issue template...

MSP-Greg avatar Aug 10 '22 16:08 MSP-Greg

Having the info right at the top so one doesn't even need to scroll both here and in the Marketplace will possibly mean people don't need to see the issue template...

My goal is certainly not to save a few seconds to people who can't understand the trade-off of pinning to a sha and think about it. I think the main issue is the text would link directly to filing an issue, that's been removed, then people will likely give it a thought before filing an issue for a new version.

eregon avatar Aug 10 '22 16:08 eregon