Writing Excellent Bug Reports | skybert.net

Writing Excellent Bug Reports


Provide simple, concise steps to reproduce the system

Provide URIs and/or credentials to log on to a system

If you have a system where the problem can be observed and it's ok for the developer to get read access to this system, provide URIs, user names and passwords necessary to access this system and view the problem.

The best thing you can provide is an absolute URI which the coder can click on and instantly, without clicking or pressing anything, can view the problem.

State what you expected to happen

This might be obvious to you "When I press 'Save' it should store my document", but save everyone some time and clearly (and bluntly) state what you expect would happen.

Browser's Network inspector

Include relevant information from the logs

Tomcat

If you're backend is Tomcat, checkout all the files in tomcat/logs

Nginx

/var/log/nginx/error.log and /var/log/access.log

Escenic

Escenic Content Engine has several log files, be sure to include relevant portions from all of them


Licensed under CC BY Creative Commons License ~ ✉ torstein.k.johansen @ gmail ~ 🐦 @torsteinkrause ~