Author Topic: How to write a helpful bug report  (Read 7574 times)

Anaris

  • BM Dev Team
  • Exalted Emperor
  • *
  • Posts: 8078
    • View Profile
Re: How to write a helpful bug report
« Topic Start: February 16, 2012, 01:43:04 AM »
SQL: an example would be the top of the military planner:
Warning: mysql_fetch_assoc() expects parameter 1 to be resource, string given in /var/battlemaster/include/db.inc on line 233

Nope, that's not a SQL error. That's actually a PHP error. Just because it mentions MySQL doesn't mean it's a SQL error.

Generally, a SQL error will actually give you at least part of a SQL query. These days, it will actually give you a whole bunch of Doctrine stacktrace.

Parse errors are almost always a white screen with a single line on it.

However, generally, the important thing to remember is this:

Don't worry too much about the error type or the severity.

We, as devs, are good enough at categorizing bugs just by looking at them that we generally don't need the metadata.  And, frankly, we don't expect our players to be savvy enough about code to put in the right values.

What we do need is as much information about the bug as you can provide, including (generally) the URL you see it on and the full text of the error, if it's an error message.  And if there's other text on the page, including that is good, too, because it can give us the context of the error (i.e., where it happens in the code).
Timothy Collett

"The only thing you can't trade for your heart's desire...is your heart." "You are what you do.  Choose again, and change." "One of these days, someone's gonna plug you, and you're going to die saying, 'What did I say? What did I say?'"  ~ Miles Naismith Vorkosigan