mirror of
https://github.com/rails/rails.git
synced 2022-11-09 12:12:34 -05:00
Reword sentences in contributing docs for clarity.
[skip ci] - removes use "squash" where it doesn't apply to git - "is a help" -> "helps" - "if your comment simply says" -> "... simply reads"
This commit is contained in:
parent
1cb94077d9
commit
0fcef173d4
1 changed files with 3 additions and 3 deletions
|
@ -85,11 +85,11 @@ As a next step beyond reporting issues, you can help the core team resolve exist
|
|||
|
||||
For starters, it helps just to verify bug reports. Can you reproduce the reported issue on your own computer? If so, you can add a comment to the issue saying that you're seeing the same thing.
|
||||
|
||||
If something is very vague, can you help squash it down into something specific? Maybe you can provide additional information to help reproduce a bug, or help by eliminating needless steps that aren't required to demonstrate the problem.
|
||||
If an issue is very vague, can you help narrow it down to something more specific? Maybe you can provide additional information to help reproduce a bug, or help by eliminating needless steps that aren't required to demonstrate the problem.
|
||||
|
||||
If you find a bug report without a test, it's very useful to contribute a failing test. This is also a great way to get started exploring the source code: looking at the existing test files will teach you how to write more tests. New tests are best contributed in the form of a patch, as explained later on in the "Contributing to the Rails Code" section.
|
||||
|
||||
Anything you can do to make bug reports more succinct or easier to reproduce is a help to folks trying to write code to fix those bugs - whether you end up writing the code yourself or not.
|
||||
Anything you can do to make bug reports more succinct or easier to reproduce helps folks trying to write code to fix those bugs - whether you end up writing the code yourself or not.
|
||||
|
||||
### Testing Patches
|
||||
|
||||
|
@ -117,7 +117,7 @@ Once you're happy that the pull request contains a good change, comment on the G
|
|||
|
||||
>I like the way you've restructured that code in generate_finder_sql - much nicer. The tests look good too.
|
||||
|
||||
If your comment simply says "+1", then odds are that other reviewers aren't going to take it too seriously. Show that you took the time to review the pull request.
|
||||
If your comment simply reads "+1", then odds are that other reviewers aren't going to take it too seriously. Show that you took the time to review the pull request.
|
||||
|
||||
Contributing to the Rails Documentation
|
||||
---------------------------------------
|
||||
|
|
Loading…
Reference in a new issue