Contributing to Ruby on Rails Guide: standardize git remote names [ci skip]. #33891
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.
Summary
As a new contributor, I found that the git commands in the Contributing to Ruby on Rails
Guide are confusing.
The git remote name for rails/rails is "upstream", "rails", and "origin" in different parts of the guide.
The git remote name for the forked repository on the user's github account is "mine" and "origin". Sometimes "origin" refers to rails/rails and sometimes it refers to username/rails!
Also, the contribution branch name is "my_new_branch" and "my_pull_request" which is confusing.
This pull request standardizes the remote and branch names and removes some unhelpful instructions. "rails" now refers to rails/rails and "fork" now refers to username/rails. The contribution branch name is now "my_new_branch" throughout.
I have tested the commands.