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
Copy file name to clipboardExpand all lines: guides/source/contributing_to_ruby_on_rails.md
+9-9Lines changed: 9 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -145,7 +145,7 @@ Once you open a PR, a preview of the documentation will be deployed for easy rev
145
145
146
146

147
147
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.
149
149
150
150

151
151
@@ -300,7 +300,7 @@ Inspecting 1 file
300
300
For changes that might have an impact on performance, please benchmark your
301
301
code and measure the impact. Please share the benchmark script you used as well
302
302
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
304
304
determine if they are still relevant. (For example, future optimizations in the
305
305
Ruby VM might render certain optimizations unnecessary.)
306
306
@@ -485,7 +485,7 @@ You can invoke `test_jdbcmysql`, `test_jdbcsqlite3` or `test_jdbcpostgresql` als
485
485
486
486
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`.
487
487
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.
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.
497
497
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.
499
499
500
500
### Updating the Documentation
501
501
502
502
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.
503
503
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.
505
505
506
506
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.
507
507
@@ -532,7 +532,7 @@ A CHANGELOG entry should summarize what was changed and should end with the auth
532
532
533
533
### Breaking Changes
534
534
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
536
536
change. To ease upgrading Rails applications, breaking changes require a
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
616
616
`configuration.md`:
617
617
618
618
```markdown
@@ -702,7 +702,7 @@ No conflicts? Tests still pass? Change still seems reasonable to you? Then push
702
702
$ git push --force-with-lease
703
703
```
704
704
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.
706
706
707
707
### Fork
708
708
@@ -744,7 +744,7 @@ $ git push fork my_new_branch
744
744
745
745
### Open a Pull Request
746
746
747
-
Navigate to the Rails repository you just pushed to (e.g.
747
+
Navigate to the Rails repository you just pushed to (e.g.,
748
748
https://github.com/your-user-name/rails) and click on "Pull Requests" in the top bar (just above the code).
749
749
On the next page, click "New pull request" in the upper right-hand corner.
0 commit comments