Extract contributing guideline into a CONTRIBUTING.md #1056
+57
−31
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
st0012
force-pushed
the
update-contributing-guide
branch
2 times, most recently
from
4300692 to
c60ede9
Compare
st0012
commented
Dec 28, 2024
| @@ -109,39 +109,9 @@ IRB `v1.13.0` and later versions allows users/libraries to extend its functional | |||
|
|
|||
| For more information, please visit the [IRB Extension Guide](https://ruby.github.io/irb/EXTEND_IRB_md.html). | |||
|
|
|||
| ## Development | |||
There was a problem hiding this comment.
I don't see this section providing much useful info as the releasing guideline is out of date too (pushing .gem isn't needed anymore). So I decided to drop it without replacement atm.
CONTRIBUTING.md
Outdated
| 1. Fork the project to your GitHub account | ||
| 2. Clone the fork with `git clone git@github.com:[your_username]/irb.git` | ||
| 3. Run `bundle install` | ||
| 4. Run `bundle exec rake` to make sure tests pass locally |
There was a problem hiding this comment.
Minor: each of these sentences could end in a period. Makes for easier parsing, I think.
There was a problem hiding this comment.
I've updated but I don't understand about the parsing argument. Do you mind elaborating?
There was a problem hiding this comment.
Oh, "parse" as in "easier to read for a human reader".
st0012
force-pushed
the
update-contributing-guide
branch
from
c60ede9 to
b95a18b
Compare
tompng
approved these changes
Jan 3, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.