Skip to content

Commit 457b7ff

Browse files
committed
proper casing in pronouns; relocate the pro git book [ci skip]
- Cases in point - GitHub, Git, Twitter and Rails should start with capitals when used outside code context - Pro Git found - URL has been updated for its new home - Faces for links - More descriptive titles on link prompt instead of "here"
1 parent 4c711f1 commit 457b7ff

File tree

4 files changed

+36
-36
lines changed

4 files changed

+36
-36
lines changed

RELEASING_RAILS.rdoc

+9-9
Original file line numberDiff line numberDiff line change
@@ -25,10 +25,10 @@ for Rails. You can check the status of his tests here:
2525

2626
Do not release with Red AWDwR tests.
2727

28-
=== Do we have any git dependencies? If so, contact those authors.
28+
=== Do we have any Git dependencies? If so, contact those authors.
2929

30-
Having git dependencies indicates that we depend on unreleased code.
31-
Obviously rails cannot be released when it depends on unreleased code.
30+
Having Git dependencies indicates that we depend on unreleased code.
31+
Obviously Rails cannot be released when it depends on unreleased code.
3232
Contact the authors of those particular gems and work out a release date that
3333
suits them.
3434

@@ -115,14 +115,14 @@ what to do in case anything goes wrong:
115115
=== Send Rails release announcements
116116

117117
Write a release announcement that includes the version, changes, and links to
118-
github where people can find the specific commit list. Here are the mailing
118+
GitHub where people can find the specific commit list. Here are the mailing
119119
lists where you should announce:
120120

121121
122122
123123
124124

125-
Use markdown format for your announcement. Remember to ask people to report
125+
Use Markdown format for your announcement. Remember to ask people to report
126126
issues with the release candidate to the rails-core mailing list.
127127

128128
IMPORTANT: If any users experience regressions when using the release
@@ -131,16 +131,16 @@ break existing applications.
131131

132132
=== Post the announcement to the Rails blog.
133133

134-
If you used markdown format for your email, you can just paste it in to the
134+
If you used Markdown format for your email, you can just paste it in to the
135135
blog.
136136

137137
* http://weblog.rubyonrails.org
138138

139-
=== Post the announcement to the Rails twitter account.
139+
=== Post the announcement to the Rails Twitter account.
140140

141141
== Time between release candidate and actual release
142142

143-
Check the rails-core mailing list and the github issue list for regressions in
143+
Check the rails-core mailing list and the GitHub issue list for regressions in
144144
the RC.
145145

146146
If any regressions are found, fix the regressions and repeat the release
@@ -167,7 +167,7 @@ Today, do this stuff in this order:
167167
* Email security lists
168168
* Email general announcement lists
169169

170-
=== Emailing the rails security announce list
170+
=== Emailing the Rails security announce list
171171

172172
Email the security announce list once for each vulnerability fixed.
173173

guides/source/contributing_to_ruby_on_rails.textile

+13-13
Original file line numberDiff line numberDiff line change
@@ -42,12 +42,12 @@ To move on from submitting bugs to helping resolve existing issues or contributi
4242

4343
h4. Install Git
4444

45-
Ruby on Rails uses git for source code control. The "git homepage":http://git-scm.com/ has installation instructions. There are a variety of resources on the net that will help you get familiar with git:
45+
Ruby on Rails uses Git for source code control. The "Git homepage":http://git-scm.com/ has installation instructions. There are a variety of resources on the net that will help you get familiar with Git:
4646

47-
* "Everyday Git":http://schacon.github.com/git/everyday.html will teach you just enough about git to get by.
48-
* The "PeepCode screencast":https://peepcode.com/products/git on git ($9) is easier to follow.
49-
* "GitHub":http://help.github.com offers links to a variety of git resources.
50-
* "Pro Git":http://progit.org/book/ is an entire book about git with a Creative Commons license.
47+
* "Everyday Git":http://schacon.github.com/git/everyday.html will teach you just enough about Git to get by.
48+
* The "PeepCode screencast":https://peepcode.com/products/git on Git ($9) is easier to follow.
49+
* "GitHub":http://help.github.com offers links to a variety of Git resources.
50+
* "Pro Git":http://git-scm.com/book is an entire book about Git with a Creative Commons license.
5151

5252
h4. Clone the Ruby on Rails Repository
5353

@@ -74,7 +74,7 @@ If you are on Fedora or CentOS, you can run
7474
$ sudo yum install libxml2 libxml2-devel libxslt libxslt-devel
7575
</shell>
7676

77-
If you have any problems with these libraries, you should install them manually compiling the source code. Just follow the instructions "here":http://nokogiri.org/tutorials/installing_nokogiri.html#red_hat__centos .
77+
If you have any problems with these libraries, you should install them manually compiling the source code. Just follow the instructions at the "Red Hat/CentOS section of the Nokogiri tutorials":http://nokogiri.org/tutorials/installing_nokogiri.html#red_hat__centos .
7878

7979
Also, SQLite3 and its development files for the +sqlite3-ruby+ gem -- in Ubuntu you're done with just
8080

@@ -250,7 +250,7 @@ $ git branch --track 3-0-stable origin/3-0-stable
250250
$ git checkout 3-0-stable
251251
</shell>
252252

253-
TIP: You may want to "put your git branch name in your shell prompt":http://qugstart.com/blog/git-and-svn/add-colored-git-branch-name-to-your-shell-prompt/ to make it easier to remember which version of the code you're working with.
253+
TIP: You may want to "put your Git branch name in your shell prompt":http://qugstart.com/blog/git-and-svn/add-colored-git-branch-name-to-your-shell-prompt/ to make it easier to remember which version of the code you're working with.
254254

255255
h3. Helping to Resolve Existing Issues
256256

@@ -331,7 +331,7 @@ $ cd rails
331331
$ git checkout -b my_new_branch
332332
</shell>
333333

334-
It doesn’t matter much what name you use, because this branch will only exist on your local computer and your personal repository on Github. It won't be part of the Rails git repository.
334+
It doesn’t matter much what name you use, because this branch will only exist on your local computer and your personal repository on Github. It won't be part of the Rails Git repository.
335335

336336
h4. Write Your Code
337337

@@ -367,7 +367,7 @@ You might want also to check out the "RailsBridge BugMash":http://wiki.railsbrid
367367

368368
h4. Commit Your Changes
369369

370-
When you're happy with the code on your computer, you need to commit the changes to git:
370+
When you're happy with the code on your computer, you need to commit the changes to Git:
371371

372372
<shell>
373373
$ git commit -a
@@ -386,7 +386,7 @@ the commit content is obvious, it may not be obvious to others. You
386386
should add such description also if it's already present in bug tracker,
387387
it should not be necessary to visit a webpage to check the history.
388388

389-
Description can have multiple paragraps and you can use code examples
389+
Description can have multiple paragraphs and you can use code examples
390390
inside, just indent it with 4 spaces:
391391

392392
class PostsController
@@ -495,7 +495,7 @@ It’s entirely possible that the feedback you get will suggest changes. Don’t
495495

496496
h4. Backporting
497497

498-
Changes that are merged into master are intended for the next major release of Rails. Sometimes, it might be beneficial for your changes to propagate back to the maintenance releases for older stable branches. Generally, security fixes and bug fixes are good candidates for a backport, while new features and patches that introduce a change in behavior will not be accepted. When in doubt, it is best to consult a rails team member before backporting your changes to avoid wasted effort.
498+
Changes that are merged into master are intended for the next major release of Rails. Sometimes, it might be beneficial for your changes to propagate back to the maintenance releases for older stable branches. Generally, security fixes and bug fixes are good candidates for a backport, while new features and patches that introduce a change in behavior will not be accepted. When in doubt, it is best to consult a Rails team member before backporting your changes to avoid wasted effort.
499499

500500
For simple fixes, the easiest way to backport your changes is to "extract a diff from your changes in master and apply them to the target branch":http://ariejan.net/2009/10/26/how-to-create-and-apply-a-patch-with-git.
501501

@@ -520,9 +520,9 @@ $ git apply ~/my_changes.patch
520520

521521
This works well for simple changes. However, if your changes are complicated or if the code in master has deviated significantly from your target branch, it might require more work on your part. The difficulty of a backport varies greatly from case to case, and sometimes it is simply not worth the effort.
522522

523-
Once you have resolved all conflicts and made sure all the tests are passing, push your changes and open a separate pull request for your backport. It is also worth noting that older branches might have a different set of build targets than master. When possible, it is best to first test your backport locally against the ruby versions listed in +.travis.yml+ before submitting your pull request.
523+
Once you have resolved all conflicts and made sure all the tests are passing, push your changes and open a separate pull request for your backport. It is also worth noting that older branches might have a different set of build targets than master. When possible, it is best to first test your backport locally against the Ruby versions listed in +.travis.yml+ before submitting your pull request.
524524

525-
And then ... think about your next contribution!
525+
And then... think about your next contribution!
526526

527527
h3. Rails Contributors
528528

guides/source/initialization.textile

+7-7
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ NOTE: Paths in this guide are relative to Rails or a Rails application unless ot
1717

1818
TIP: If you want to follow along while browsing the Rails "source
1919
code":https://github.com/rails/rails, we recommend that you use the +t+
20-
key binding to open the file finder inside github and find files
20+
key binding to open the file finder inside GitHub and find files
2121
quickly.
2222

2323
h3. Launch!
@@ -359,7 +359,7 @@ set earlier) is required.
359359
h4. +config/application+
360360

361361
When +require APP_PATH+ is executed, +config/application.rb+ is loaded.
362-
This is a file exists in your app and it's free for you to change based
362+
This file exists in your app and it's free for you to change based
363363
on your needs.
364364

365365
h4. +Rails::Server#start+
@@ -453,7 +453,7 @@ end
453453

454454
The interesting part for a Rails app is the last line, +server.run+. Here we encounter the +wrapped_app+ method again, which this time
455455
we're going to explore more (even though it was executed before, and
456-
thus memoized by now).
456+
thus memorized by now).
457457

458458
<ruby>
459459
@wrapped_app ||= build_app app
@@ -540,12 +540,12 @@ end
540540
</ruby>
541541

542542
This is where all the Rails frameworks are loaded and thus made
543-
available to the application. We wont go into detail of what happens
543+
available to the application. We won't go into detail of what happens
544544
inside each of those frameworks, but you're encouraged to try and
545545
explore them on your own.
546546

547547
For now, just keep in mind that common functionality like Rails engines,
548-
I18n and Rails configuration is all bein defined here.
548+
I18n and Rails configuration is all being defined here.
549549

550550
h4. Back to +config/environment.rb+
551551

@@ -657,10 +657,10 @@ def self.run(app, options={})
657657
end
658658
</ruby>
659659

660-
We wont dig into the server configuration itself, but this is
660+
We won't dig into the server configuration itself, but this is
661661
the last piece of our journey in the Rails initialization process.
662662

663-
This high level overview will help you understand when you code is
663+
This high level overview will help you understand when your code is
664664
executed and how, and overall become a better Rails developer. If you
665665
still want to know more, the Rails source code itself is probably the
666666
best place to go next.

guides/source/plugins.textile

+7-7
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ After reading this guide you should be familiar with:
1313

1414
This guide describes how to build a test-driven plugin that will:
1515

16-
* Extend core ruby classes like Hash and String
16+
* Extend core Ruby classes like Hash and String
1717
* Add methods to ActiveRecord::Base in the tradition of the 'acts_as' plugins
1818
* Give you information about where to put generators in your plugin.
1919

@@ -28,7 +28,7 @@ h3. Setup
2828
_"vendored plugins"_ were available in previous versions of Rails, but they are deprecated in
2929
Rails 3.2, and will not be available in the future.
3030

31-
Currently, Rails plugins are built as gems, _gemified plugins_. They can be shared accross
31+
Currently, Rails plugins are built as gems, _gemified plugins_. They can be shared across
3232
different rails applications using RubyGems and Bundler if desired.
3333

3434
h4. Generate a gemified plugin.
@@ -392,7 +392,7 @@ the creation of generators can be found in the "Generators Guide":generators.htm
392392
h3. Publishing your Gem
393393

394394
Gem plugins currently in development can easily be shared from any Git repository. To share the Yaffle gem with others, simply
395-
commit the code to a Git repository (like Github) and add a line to the Gemfile of the application in question:
395+
commit the code to a Git repository (like GitHub) and add a line to the Gemfile of the application in question:
396396

397397
<ruby>
398398
gem 'yaffle', :git => 'git://github.com/yaffle_watcher/yaffle.git'
@@ -401,7 +401,7 @@ gem 'yaffle', :git => 'git://github.com/yaffle_watcher/yaffle.git'
401401
After running +bundle install+, your gem functionality will be available to the application.
402402

403403
When the gem is ready to be shared as a formal release, it can be published to "RubyGems":http://www.rubygems.org.
404-
For more information about publishing gems to RubyGems, see: "http://blog.thepete.net/2010/11/creating-and-publishing-your-first-ruby.html":http://blog.thepete.net/2010/11/creating-and-publishing-your-first-ruby.html
404+
For more information about publishing gems to RubyGems, see: "Creating and Publishing Your First Ruby Gem":http://blog.thepete.net/2010/11/creating-and-publishing-your-first-ruby.html
405405

406406
h3. RDoc Documentation
407407

@@ -414,7 +414,7 @@ The first step is to update the README file with detailed information about how
414414
* How to add the functionality to the app (several examples of common use cases)
415415
* Warnings, gotchas or tips that might help users and save them time
416416

417-
Once your README is solid, go through and add rdoc comments to all of the methods that developers will use. It's also customary to add '#:nodoc:' comments to those parts of the code that are not included in the public api.
417+
Once your README is solid, go through and add rdoc comments to all of the methods that developers will use. It's also customary to add '#:nodoc:' comments to those parts of the code that are not included in the public API.
418418

419419
Once your comments are good to go, navigate to your plugin directory and run:
420420

@@ -425,6 +425,6 @@ $ rake rdoc
425425
h4. References
426426

427427
* "Developing a RubyGem using Bundler":https://github.com/radar/guides/blob/master/gem-development.md
428-
* "Using Gemspecs As Intended":http://yehudakatz.com/2010/04/02/using-gemspecs-as-intended/
428+
* "Using .gemspecs as Intended":http://yehudakatz.com/2010/04/02/using-gemspecs-as-intended/
429429
* "Gemspec Reference":http://docs.rubygems.org/read/chapter/20
430-
* "GemPlugins":http://www.intridea.com/blog/2008/6/11/gemplugins-a-brief-introduction-to-the-future-of-rails-plugins
430+
* "GemPlugins: A Brief Introduction to the Future of Rails Plugins":http://www.intridea.com/blog/2008/6/11/gemplugins-a-brief-introduction-to-the-future-of-rails-plugins

0 commit comments

Comments
 (0)