26
www.WordCampMSP.org T w e e t a b o u t t h i s s e s s i o n # W o r d C a m p M S P ! ! ! HOW-TO: REPORTING ISSUES WP201: Do-it-yourself Track Follow John Havlik @mtekkmonkey

How to: Reporting Issues

Embed Size (px)

DESCRIPTION

John Havlik's presentation from WordCamp MSP 2010

Citation preview

Page 1: How to: Reporting Issues

www.

Wor

dCam

pMSP

.org

Tweet about this session #WordCam

pMSP

!!!

HOW-TO: REPORTING ISSUESWP201: Do-it-yourself Track

Follow John Havlik @mtekkmonkey

Page 2: How to: Reporting Issues

www.

Wor

dCam

pMSP

.org

Tweet about this session #WordCam

pMSP

!!!

• WordPress user since 2005• Plugin developer since 2006• Maintain Breadcrumb NavXT

• Administrator for Weblogs.us• Blog: mtekk.us

About Me

Page 3: How to: Reporting Issues

www.

Wor

dCam

pMSP

.org

Tweet about this session #WordCam

pMSP

!!!

• Basic troubleshooting• Is it a bug?• Reporting your find• Using Trac• Using the Forums

Overview

Page 4: How to: Reporting Issues

www.

Wor

dCam

pMSP

.org

Tweet about this session #WordCam

pMSP

!!!

TROUBLESHOOTINGBasic

Page 5: How to: Reporting Issues

www.

Wor

dCam

pMSP

.org

Tweet about this session #WordCam

pMSP

!!!

• Troubleshooting is a systematic search for the root cause of an issue

• Often necessary for solving issues in complex systems (WordPress)

Basic Troubleshooting

Page 6: How to: Reporting Issues

www.

Wor

dCam

pMSP

.org

Tweet about this session #WordCam

pMSP

!!!

• Five basic steps:1. Define the problem2. Reproduce the problem3. Identify possible solutions4. Test possible solutions5. Evaluate results

• Iterate these steps until the problem is solved

The Steps

Page 7: How to: Reporting Issues

www.

Wor

dCam

pMSP

.org

Tweet about this session #WordCam

pMSP

!!!

1. Misbehaving plugins2. Misbehaving themes3. Improperly configured WordPress install4. Improperly configured server• Cause majority of WordPress related issues

The Usual Suspects

Page 8: How to: Reporting Issues

www.

Wor

dCam

pMSP

.org

Tweet about this session #WordCam

pMSP

!!!

• “White Screen of Death”• Fatal memory error• Internal server error (Error 500)• Headers already sent error

Common Problems

Page 9: How to: Reporting Issues

www.

Wor

dCam

pMSP

.org

Tweet about this session #WordCam

pMSP

!!!

• Disable all plugins• If this fixed it, re-enable one-by-one to find the culprit

• Change theme to Twenty Ten (WP 3.0+)• If this fixed it, look at your theme’s functions.php file

• Re-upload the WordPress core files

Common Remedies

Page 10: How to: Reporting Issues

www.

Wor

dCam

pMSP

.org

Tweet about this session #WordCam

pMSP

!!!

• Think critically, not magically• Always start with the simplest and most likely cause• Try undoing your most recent actions• Don’t be afraid to ask for help if you get stuck

Troubleshooting Tips

Page 11: How to: Reporting Issues

www.

Wor

dCam

pMSP

.org

Tweet about this session #WordCam

pMSP

!!!

• Error messages can be helpful• Parse error: parse error, unexpected T_STRING, expecting

T_OLD_FUNCTION or T_FUNCTION or T_VAR or ‘}’ in /wp-content/plugins/breadcrumb-navxt/breadcrumb_navxt_admin.php on line 53

• Error messages can be misleading• Warning: strpos() expects parameter 1 to be string, array

given in /wp-admin/includes/media.php on line 310• Warning: Cannot modify header information - headers already

sent by (output started at /wp-config.php:34) in /path/blog/wp-login.php on line 42

More Tips

Page 12: How to: Reporting Issues

www.

Wor

dCam

pMSP

.org

Tweet about this session #WordCam

pMSP

!!!

BUG?Is it a

Page 13: How to: Reporting Issues

www.

Wor

dCam

pMSP

.org

Tweet about this session #WordCam

pMSP

!!!

• Check the documentation• codex.wordpress.org• Plugin/theme author’s plugin/theme page

• Check the forums• wordpress.org/support

Is it a BUG?

Page 14: How to: Reporting Issues

www.

Wor

dCam

pMSP

.org

Tweet about this session #WordCam

pMSP

!!!

• Intermittent behavior is very difficult to fix• Create a list of steps to trigger the bug• Try them on a “clean slate”

Is it Reproducible?

Page 15: How to: Reporting Issues

www.

Wor

dCam

pMSP

.org

Tweet about this session #WordCam

pMSP

!!!

YOUR FINDReporting

Page 16: How to: Reporting Issues

www.

Wor

dCam

pMSP

.org

Tweet about this session #WordCam

pMSP

!!!

• For WordPress issues:• WordPress Trac (general)• [email protected] (security)

• For plugin/theme issues:• WordPress.org forums• Developer’s page for the plugin/theme

Reporting Your Find

Page 17: How to: Reporting Issues

www.

Wor

dCam

pMSP

.org

Tweet about this session #WordCam

pMSP

!!!

• Provide instructions to reproduce the bug• Provide as much detail as you can• Always include the version of WordPress• For plugin/theme issues: • Include the plugin/theme version

Things to Remember

Page 18: How to: Reporting Issues

www.

Wor

dCam

pMSP

.org

Tweet about this session #WordCam

pMSP

!!!

USING TRACReporting Your Find:

Page 19: How to: Reporting Issues

www.

Wor

dCam

pMSP

.org

Tweet about this session #WordCam

pMSP

!!!

• http://core.trac.wordpress.org• Login using your wordpress.org credentials

Using Trac

Page 20: How to: Reporting Issues

www.

Wor

dCam

pMSP

.org

Tweet about this session #WordCam

pMSP

!!!

1. Search for your bug• If an existing ticket exists:• Don’t open a new ticket• Add a note providing more information

2. Open a ticket

Reporting Bugs Using Trac

Page 21: How to: Reporting Issues

www.

Wor

dCam

pMSP

.org

Tweet about this session #WordCam

pMSP

!!!

Opening a Trac Ticket•Summary – Keep it concise•Description – Full detail•Severity – If in doubt, leave this alone•Version & Component – The WordPress version, and component the bug was found in.

Page 22: How to: Reporting Issues

www.

Wor

dCam

pMSP

.org

Tweet about this session #WordCam

pMSP

!!!

USING THE FORUMSReporting Your Find:

Page 23: How to: Reporting Issues

www.

Wor

dCam

pMSP

.org

Tweet about this session #WordCam

pMSP

!!!

• For Plugins and Themes• Go to the extension’s wordpress.org/extend page• E.g. wordpress.org/extend/plugins/wp-lynx

• Click on the “others are saying” link• Click on the “Add New” link on the next page

Using the Forums

Page 24: How to: Reporting Issues

www.

Wor

dCam

pMSP

.org

Tweet about this session #WordCam

pMSP

!!!

Starting a New Topic•Fill out Topic title describing the issue•Set Version to the WordPress version you experience the issue in•Message should contain:

•Steps to reproduce•Version of the plugin/theme

•Add additional tags if appropriate•Don’t remove what was automatically inserted

•Don’t change the section•Check the subscribe box

Page 25: How to: Reporting Issues

www.

Wor

dCam

pMSP

.org

Tweet about this session #WordCam

pMSP

!!!

• Check in on your tickets/forum topics• Many times more information is needed• Fixes may be made need testing

Final Thoughts

Page 26: How to: Reporting Issues

www.

Wor

dCam

pMSP

.org

Tweet about this session #WordCam

pMSP

!!!

QUESTIONS?Any