Skip to content

Commit 171c4e4

Browse files
authored
Merge pull request rails#52732 from antonvasilev52/patch-1
[ci skip] Punctuation fixes in contributing_to_ruby_on_rails.md
2 parents f0fd6ab + 9949c10 commit 171c4e4

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

guides/source/contributing_to_ruby_on_rails.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -145,7 +145,7 @@ Once you open a PR, a preview of the documentation will be deployed for easy rev
145145

146146
![GitHub rails/rails Pull Request status checks](images/docs_preview/status_checks.png)
147147

148-
This will bring you to the Buildkite build page, if the job was successful there will be an annotation with links to the generated API and Guides above the job list.
148+
This will bring you to the Buildkite build page. If the job was successful, there will be an annotation with links to the generated API and Guides above the job list.
149149

150150
![Buildkite rails/docs-preview annotation API & Guides links](images/docs_preview/annotation.png)
151151

@@ -300,7 +300,7 @@ Inspecting 1 file
300300
For changes that might have an impact on performance, please benchmark your
301301
code and measure the impact. Please share the benchmark script you used as well
302302
as the results. You should consider including this information in your commit
303-
message, to allow future contributors to easily verify your findings and
303+
message to allow future contributors to easily verify your findings and
304304
determine if they are still relevant. (For example, future optimizations in the
305305
Ruby VM might render certain optimizations unnecessary.)
306306

@@ -485,7 +485,7 @@ You can invoke `test_jdbcmysql`, `test_jdbcsqlite3` or `test_jdbcpostgresql` als
485485

486486
To use an external debugger (pry, byebug, etc), install the debugger and use it as normal. If debugger issues occur, run tests in serial by setting `PARALLEL_WORKERS=1` or run a single test with `-n test_long_test_name`.
487487

488-
If running tests against generators you will need to set `RAILS_LOG_TO_STDOUT=true` in order for debugging tools to work.
488+
If running tests against generators, you will need to set `RAILS_LOG_TO_STDOUT=true` in order for debugging tools to work.
489489

490490
```sh
491491
RAILS_LOG_TO_STDOUT=true ./bin/test test/generators/actions_test.rb
@@ -495,13 +495,13 @@ RAILS_LOG_TO_STDOUT=true ./bin/test test/generators/actions_test.rb
495495

496496
The test suite runs with warnings enabled. Ideally, Ruby on Rails should issue no warnings, but there may be a few, as well as some from third-party libraries. Please ignore (or fix!) them, if any, and submit patches that do not issue new warnings.
497497

498-
Rails CI will raise if warnings are introduced. To implement the same behavior locally set `RAILS_STRICT_WARNINGS=1` when running the test suite.
498+
Rails CI will raise if warnings are introduced. To implement the same behavior locally, set `RAILS_STRICT_WARNINGS=1` when running the test suite.
499499

500500
### Updating the Documentation
501501

502502
The Ruby on Rails [guides](https://guides.rubyonrails.org/) provide a high-level overview of Rails' features, while the [API documentation](https://api.rubyonrails.org/) delves into specifics.
503503

504-
If your PR adds a new feature, or changes how an existing feature behaves, check the relevant documentation, and update it or add to it as necessary.
504+
If your PR adds a new feature or changes how an existing feature behaves, check the relevant documentation and update it or add to it as necessary.
505505

506506
For example, if you modify Active Storage's image analyzer to add a new metadata field, you should update the [Analyzing Files](active_storage_overview.html#analyzing-files) section of the Active Storage guide to reflect that.
507507

@@ -532,7 +532,7 @@ A CHANGELOG entry should summarize what was changed and should end with the auth
532532

533533
### Breaking Changes
534534

535-
Anytime a change could break existing applications it's considered a breaking
535+
Anytime a change could break existing applications, it's considered a breaking
536536
change. To ease upgrading Rails applications, breaking changes require a
537537
deprecation cycle.
538538

@@ -612,7 +612,7 @@ value:
612612
# Rails.application.config.active_job.existing_behavior = false
613613
```
614614

615-
As a last step add the new configuration to configuration guide in
615+
As a last step, add the new configuration to configuration guide in
616616
`configuration.md`:
617617

618618
```markdown
@@ -702,7 +702,7 @@ No conflicts? Tests still pass? Change still seems reasonable to you? Then push
702702
$ git push --force-with-lease
703703
```
704704

705-
We disallow force pushing on the rails/rails repository base, but you are able to force push to your fork. When rebasing this is a requirement since the history has changed.
705+
We disallow force pushing on the rails/rails repository base, but you are able to force push to your fork. When rebasing, this is a requirement since the history has changed.
706706

707707
### Fork
708708

@@ -744,7 +744,7 @@ $ git push fork my_new_branch
744744

745745
### Open a Pull Request
746746

747-
Navigate to the Rails repository you just pushed to (e.g.
747+
Navigate to the Rails repository you just pushed to (e.g.,
748748
https://github.com/your-user-name/rails) and click on "Pull Requests" in the top bar (just above the code).
749749
On the next page, click "New pull request" in the upper right-hand corner.
750750

0 commit comments

Comments
 (0)