diff options
| author | Claudio B. <claudiob@users.noreply.github.com> | 2015-05-23 18:07:15 -0700 |
|---|---|---|
| committer | Claudio B. <claudiob@users.noreply.github.com> | 2015-05-23 18:07:15 -0700 |
| commit | 281581f76fa1c4ed509bfc7e86f7a1be4bd3d6a8 (patch) | |
| tree | 2ce5546d3259a91f5508a756df7ee4a994609763 /guides/source | |
| parent | c10630b642bc6dc77b719385d6ba6a1569a6e739 (diff) | |
| parent | 0fcef173d408022e59cd8825da79106c01f6c65c (diff) | |
| download | rails-281581f76fa1c4ed509bfc7e86f7a1be4bd3d6a8.tar.gz rails-281581f76fa1c4ed509bfc7e86f7a1be4bd3d6a8.tar.bz2 rails-281581f76fa1c4ed509bfc7e86f7a1be4bd3d6a8.zip | |
Merge pull request #20278 from dleve123/cleanup-contributing-docs-section
Cleanup docs for contributing to rails docs
Diffstat (limited to 'guides/source')
| -rw-r--r-- | guides/source/contributing_to_ruby_on_rails.md | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/guides/source/contributing_to_ruby_on_rails.md b/guides/source/contributing_to_ruby_on_rails.md index 39a9826f21..b2cfd6220c 100644 --- a/guides/source/contributing_to_ruby_on_rails.md +++ b/guides/source/contributing_to_ruby_on_rails.md @@ -79,17 +79,17 @@ discussions new features require. Helping to Resolve Existing Issues ---------------------------------- -As a next step beyond reporting issues, you can help the core team resolve existing issues. If you check the [Everyone's Issues](https://github.com/rails/rails/issues) list in GitHub Issues, you'll find lots of issues already requiring attention. What can you do for these? Quite a bit, actually: +As a next step beyond reporting issues, you can help the core team resolve existing issues. If you check the [issues list](https://github.com/rails/rails/issues) in GitHub Issues, you'll find lots of issues already requiring attention. What can you do for these? Quite a bit, actually: ### Verifying Bug Reports 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 --------------------------------------- |