|
| 1 | +# Rails Tutorial Help |
| 2 | + |
| 3 | +This is the Help page for the [*Ruby on Rails Tutorial*](https://www.railstutorial.org/) (6th Edition) by [Michael Hartl](http://www.michaelhartl.com/). |
| 4 | + |
| 5 | +## General suggestions |
| 6 | + |
| 7 | +Web development is a tricky business, and despite our collective best efforts it’s likely that you’ll run into trouble at some point. If you do, I suggest comparing your code to the [reference implementation of the sample app](https://github.com/mhartl/sample_app_6th_ed) to track down any discrepancies. You can also post your question at [Stack Overflow](https://stackoverflow.com/), but I suggest you do so after trying all the debugging tips listed below. |
| 8 | + |
| 9 | +## Debugging tips |
| 10 | + |
| 11 | +While it’s impossible to anticipate every potential problem, here are |
| 12 | +some debugging tips that might help: |
| 13 | + |
| 14 | +- Have you compared your code to the [reference implementation of the sample app](https://github.com/mhartl/sample_app_6th_ed)? |
| 15 | +- Are you using the [exact gem versions](https://gemfiles-6th-ed.railstutorial.org) (including Rails) used in the |
| 16 | + tutorial? |
| 17 | +- Did you try Googling the error message? |
| 18 | +- Did you stop the Rails web server (with Ctrl-C) and restart? |
| 19 | +- Did you try stopping Spring using `bin/spring stop`? |
| 20 | +- Did you copy-and-paste from the book’s code? (Experience shows that typing in code, while a better learning technique in general, is error-prone, so when in doubt be sure to copy all code exactly.) |
| 21 | +- Did you try Googling the error message? |
| 22 | +- Did you re-run `bundle install`? |
| 23 | +- Did you try running `bundle update`? |
| 24 | +- Did you examine the Heroku logs using `heroku logs` or `heroku logs --tail`? |
| 25 | +- Did you make sure the `sqlite3` gem is listed only in the `development` and `test` environments in the `Gemfile`? |
| 26 | +- Did you look for the answer at Stack Overflow? |
| 27 | +- Did you try Googling the error message? |
| 28 | + |
| 29 | +If your problem is of a general nature, such as having issues installing |
| 30 | +Rails or configuring your system, I suggest posting to [Stack |
| 31 | +Overflow](http://stackoverflow.com/). This will allow other |
| 32 | +people running into your issue (and not just those following the Rails |
| 33 | +Tutorial) to benefit from the discussion. For issues |
| 34 | +deploying to [Heroku](http://heroku.com/), please contact [Heroku |
| 35 | +technical support](http://support.heroku.com/). |
| 36 | + |
| 37 | +When asking your question on any mailing list or forum, be sure to |
| 38 | +include as much relevant information as possible. To maximize your chances |
| 39 | +of a helpful reply, I especially recommend the article [How To Ask Questions The Smart |
| 40 | +Way](http://www.catb.org/esr/faqs/smart-questions.html) by [Eric |
| 41 | +Raymond](http://www.catb.org/esr/). |
| 42 | + |
| 43 | +## Error reports |
| 44 | + |
| 45 | +Suspected errors, typos, and bugs can be emailed to <[email protected]>. All such reports are gratefully received, but please double-check with the [online version of the tutorial ](https://www.railstutorial.org/book) and the [reference implementation ](https://github.com/mhartl/sample_app_6th_ed) before submitting. |
| 46 | + |
0 commit comments