You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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"
Copy file name to clipboardExpand all lines: guides/source/contributing_to_ruby_on_rails.textile
+13-13
Original file line number
Diff line number
Diff line change
@@ -42,12 +42,12 @@ To move on from submitting bugs to helping resolve existing issues or contributi
42
42
43
43
h4. Install Git
44
44
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:
46
46
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.
51
51
52
52
h4. Clone the Ruby on Rails Repository
53
53
@@ -74,7 +74,7 @@ If you are on Fedora or CentOS, you can run
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 .
78
78
79
79
Also, SQLite3 and its development files for the +sqlite3-ruby+ gem -- in Ubuntu you're done with just
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.
254
254
255
255
h3. Helping to Resolve Existing Issues
256
256
@@ -331,7 +331,7 @@ $ cd rails
331
331
$ git checkout -b my_new_branch
332
332
</shell>
333
333
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.
335
335
336
336
h4. Write Your Code
337
337
@@ -367,7 +367,7 @@ You might want also to check out the "RailsBridge BugMash":http://wiki.railsbrid
367
367
368
368
h4. Commit Your Changes
369
369
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:
371
371
372
372
<shell>
373
373
$ git commit -a
@@ -386,7 +386,7 @@ the commit content is obvious, it may not be obvious to others. You
386
386
should add such description also if it's already present in bug tracker,
387
387
it should not be necessary to visit a webpage to check the history.
388
388
389
-
Description can have multiple paragraps and you can use code examples
389
+
Description can have multiple paragraphs and you can use code examples
390
390
inside, just indent it with 4 spaces:
391
391
392
392
class PostsController
@@ -495,7 +495,7 @@ It’s entirely possible that the feedback you get will suggest changes. Don’t
495
495
496
496
h4. Backporting
497
497
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.
499
499
500
500
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.
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.
522
522
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.
After running +bundle install+, your gem functionality will be available to the application.
402
402
403
403
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
405
405
406
406
h3. RDoc Documentation
407
407
@@ -414,7 +414,7 @@ The first step is to update the README file with detailed information about how
414
414
* How to add the functionality to the app (several examples of common use cases)
415
415
* Warnings, gotchas or tips that might help users and save them time
416
416
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.
418
418
419
419
Once your comments are good to go, navigate to your plugin directory and run:
420
420
@@ -425,6 +425,6 @@ $ rake rdoc
425
425
h4. References
426
426
427
427
* "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/
* "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