Skip to content

Update: Deprecate the documenting-ruby workflow and refer users to ruby/ruby #6

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.

Sign up for GitHub

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

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Update: Deprecate the documenting-ruby workflow and refer users to ruby/ruby #6

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e1db75c
Update: Refer only to ruby/ruby
olleolleolle Oct 7, 2017
a0ac30b
step-by-step-guide: Link GitHub Help fork article
olleolleolle Oct 9, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
step-by-step-guide: Link GitHub Help fork article 
  - try to explain things
  • Loading branch information
@olleolleolle
olleolleolle authored Oct 9, 2017
commit a0ac30b61b70b32d7e4bc6078d302590a9c486b9
13 changes: 7 additions & 6 deletions _posts/2011-10-06-step-by-step-guide.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,23 +8,24 @@ tags:
<a name="SetUp"></a>
## Getting Set Up

The Git steps below are carefully detailed in the GitHub Help center how-to _[Fork A Repo](https://help.github.com/articles/fork-a-repo/)_.

Fork the [ruby repository on GitHub](https://github.com/ruby/ruby).

Clone your new repo:
Clone your newly-forked repository (where `YOUR_USERNAME` replaced with your GitHub username):
{% highlight bash %}
git clone git@github.com:ruby/ruby.git
git clone git@github.com:YOUR_USERNAME/ruby.git
{% endhighlight %}

Add the upstream remote:
Add the `upstream` remote:
{% highlight bash %}
git remote add upstream https://github.com/ruby/ruby.git
git fetch upstream
git merge upstream/trunk
{% endhighlight %}

Choose some code to document. You can use our [suggestions for code to
document](undocumented-areas.html) or follow these instructions to generate
your own list of undocumented code. Check ruby's [list of Doc-labeled Pull
Choose some code to document. Follow these instructions to generate
a list of undocumented code. Check ruby's [list of Doc-labeled Pull
Requests](https://github.com/ruby/ruby/labels/Doc) for a list of
documentation other people are working on.

Expand Down