Spring Framework 6
Beginner to Guru
Getting Help With Spring
Step One - Troubleshooting
• First try to determine the root cause
• Read through stack trace in console, look for an error message
• Often error message will mean exactly what it says
• i.e. - file not found - File is not found where the program is looking
• Path wrong, permissions issue?, typo in file name?
• This often gets me too, when I miss understand the meaning of the message
Step One - Troubleshooting - Cont.
• Change ONE thing at a time, re-test
• Prevents you from fixing one thing, while breaking another!
• With multiple changes you might cover up the fix by introducing another error
• Use the debugger
• When appropriate, set a break point and inspect the code to see what is happening
• If error is in 3rd party library use the IDE to download the sources and read the JavaDoc
Step One - Troubleshooting - Cont.
• There is no shame in Googling the error!
• I do this all the time!!!
• You are likely NOT the first person to encounter the error
• Search results often give you the solution, or at least point you in the right direction
• Check the course Q&A for the lesson
• Good chance another student has encountered the problem and the solution is in Q&A
Reporting a Problem
• When reporting an problem:
• Describe the error and provide details of the error message
• Describe the expected results
• Describe how to reproduce the error
• Provide a link to your GitHub repository with failing code
Example of Reporting a Problem
• Hi, I’m getting a null pointer error when saving a product
• Here is a link to a gist with the full stack trace
• Here is a link to my GitHub repository
• Run the test “[Link]” to reproduce
Things to do when reporting a problem
• Be clear and specific about the problem
• Provide the expected results
• Provide the stack trace if applicable - create a gist!
• Provide your source code, not just snippets
Things NOT to do when reporting a problem
• Don’t be vague
• ie “I have a problem, can you help me. Here is my GitHub…”
• Unless necessary, not take screenshots of the error message
• Never send a picture of your computer screen - impossible to read & typically useless
• Don’t cut and paste each class file you think is relevant - Use GitHub so error can be
reproduced
• Code snippets are okay when relevant
Where to Report for Help
• For problems in course:
• Use the lecture Q&A or Slack
• Both are monitored by myself, my assistants and other students
• For Spring Framework in general:
• Stackoverflow
• GitHub respective to Spring project
• Gitter respective to Spring project