First commit:
This PR improves the "4.12 Commit Your Changes" section of the
Contributing to Ruby on Rails Guide:
- Fix formatting of the commit message example
- Improve readability and clarity
- Fix grammar
- Wrap lines
See the before and after images below in this PR.
-----
Second commit:
- Rewrite to remove the word "buffer" [skip ci]
This is a squash of the following commits, from first to last:
-
Fix minor, random things I’ve come across lately that individually
did not seem worth making a PR for, so I saved them for one commit.
One common error is using “it’s” (which is an abbreviation of “it is”)
when the possessive “its” should be used for indicating possession.
-
Changes include the name of a test, so remove the `[skip ci]` (thanks @senny).
-
Line wrap the changes at 80 chars and add one more doc fix.
-
Add a missing line wrap in the Contributing to Ruby on Rails Guide.
-
Line wrap the `TIP` section in the Contributing to Ruby on Rails Guide as well.
Rendering the guide locally with `bundle exec rake guides:generate` did
not show any change in on-screen formatting after adding the line wrap.
The HTML generated is (extra line added to illustrate where the line
wrap takes place):
<div class="info"><p>Please squash your commits into a single commit
when appropriate. This
simplifies future cherry picks and also keeps the git log
clean.</p></div>
-
Squash commits.
1. Specify that you need to create the test databases, and that no special
Rails command needs to be run to do that.
2. Although the underscore style of `rake test_mysql` works, make the
documentation of running the tests in RUNNING_UNIT_TESTS.rdoc
consistent with the "Contributing..." guide.
3. Promote "Testing Active Record" to not be a subsection of
"Running a Single Test," since it doesn't make sense as a subsection
of that.
This commit adds new lines between titles, paragraphs and code blocks
for an easier reading.
Moreover, in order to be consistent with the other guides, let's remove
the sharps on the right side of the different titles.
The "Running a Single Test" part was also explained after the "Testing
Active Record" one which shows how to run a single test under the scope
of a specific adapter.
Finally, let's explain the `-n` option to run a specific test method.
