bug report example

[1337]

i think we should try having bug reports as clear and precise as possible so here's an example to start things of. Anything to add or take out?

(Title of post: Sky becomes green on mountain)
----------------------------------------------------------------

Version:
0.20 Alpha

Description:
When going to top of mountain, the sky turns grey and then green

Steps to Reproduce:
1. start at village XZY, go out and run straight for 1min
2. climb the big moutain to the north

Expected results:
blue sky duh

Actual results:
green sky

Consistency
Does it happen everytime you do a certain thing, or is it random? Can you make it crash again?

Reported On:
31 oct 2011 13h37

System specs/OS:
Windows XP 32bit, geforce blabla ...

Severity:
trivial (others: blocker, crash, major, minor)

Attach the crash dump
If Kenshi crashes, it will generate a file called crashDump.dmp, in the main install folder. Upload that file here on the forum when you make your report.

Attachments:
Screenshot, link to video maybe

--------------------
if the same bug was already posted, you should still include the following information as a reply in the same post (anything in parentheses might not be needed):

Version:
0.21 Alpha

Steps to Reproduce: (only if different)
1. start at village YZX, go left and run straight for 1.5min
2. climb the small moutain to the south

Consistency: (only if version or steps have changed)
Every time.
Restarting the program has no effect.

Expected results:(only if different)
blue sky duh

Actual results: (only if different)
green sky

Reported On:
1 nov 2011 2h05

System specs/OS:
Windows XP 64bit, blabla ...

Attach the crash dump
If Kenshi crashes, it will generate a file called crashDump.dmp, in the main install folder. Upload that file here on the forum when you make your report.

attachments:
Screenshot, link to video maybe

[conte]

Nice can't wait... Bug included

[ArcaneSaint]

Not so sure about adding the priority thing, it's a bit redundant with the severity option already there. And I think it's best to leave it to the developer to decide which bugs to fix with higher priority than others, as he knows best how all things interact with each other, so something that might seem trivial to us could be caused by a severe bug in the programming that could give very serious errors when the code is expanded upon. Which would mean that has to be fixed with higher priority, but we wouldn't be able to know that.

So I'd say, leave the priority out of the report, the dev(s) can always add that if they ever make a list of all known bugs (I sure hope they will, that would help to prevent double reports, if people actually read the list before posting). And perhaps change "Operating System" to "System Specs", to make it clear that more than only the OS is supposed to go there.

[1337]

I think ur right, i didn't want to include it at first too lol

But i thought that if chris comes to the forum and sees 40 50 bug reports he'd start reading first the bug reports that us testers "think" are more important (like something that crashes the game)
maybe in the title eg. : P5 sky turns green ... P1 entering city YWY kills game


took it out for now

[ArcaneSaint]

But i thought that if chris comes to the forum and sees 40 50 bug reports he'd start reading first the bug reports that us testers "think" are more important (like something that crashes the game maybe)

That purpose is served perfectly by the severity tag, if they, for some reason, only want to fix the most game-breaking bugs they only need to look at the "major" or "critical" bugs, and fix them.

And did I mention that I find this Generalized Bug Report Form (r) a Great Idea (c)? No? Well, then allow me to say: Well done sir, your efforts to the community are much appreciated. Have some bees!

[1337]

thx pal
I try to help as much as I can for this great game/community

I got nothing to do anyway, I'm insomniac lol because i'm ill... i've been online for a total of 3days 2nights and this night just started but i'm sure it will be the same -_-
and now i've run out of things to do online so i ghost around some forums, read manga, play pokerstars lol

I wanted to add this post on the bug forum but i thought i'd let u guys see it first (btw i had a hunch you'd have something to say abt it )

[TBFProgrammer]

You might want to include consistency in the form, as mentioned in Chris' crash reporting thread.
---
Posting in an already started thread with the same bug should still include the following information (anything in parentheses might not be needed):

Version:
0.21 Alpha

Steps to Reproduce: (only if different)
1. start at village YZX, go left and run straight for 1.5min
2. climb the small moutain to the south

Consistency: (only if version or steps have changed)
Every time.
Restarting the program has no effect.

Actual results: (only if different)
green sky

Reported On:
1 nov 2011 2h05

System specs/OS:
Windows XP 64bit, blabla ...

attachments:
Screenshot, link to video maybe

[ArcaneSaint]

Consistency: (only if version or steps have changed)
Every time.
Restarting the program has no effect.

Expected result
Blue sky, duh.

Actual results: (only if different)
green sky

Fixed that for you , I think it's kinda important that the expected result is mentioned as well. Because a reported bug might not actually be a bug but just the user expecting something different to happen.

EDIT: Also, by consistency I suppose you mean "Attempts already undertaken by the user to fix it"? Just making sure I'm getting it right. So if, say, standing on you head for five minutes while reciting shakespeare fixes it that should be written under consistency (Consistency: Standing on you .... reciting shakespeare fixes the bug), right?

[1337]

alright changed it to add what was asked.
If its any good, praise me! if not, praise me and let me know whats wrong thx

[TBFProgrammer]

Also, by consistency I suppose you mean "Attempts already undertaken by the user to fix it"?

Kind of. Consistency has two parts:

1) How well defined are the steps? If the bug is inconsistent, some steps have not been figured out yet. This tells other users and the programmer that the bug still requires some investigation in game.

2) If you know of a workaround, then the code run by the workaround causes the value(s) that is(are) bugged to be recalculated. This can sometimes help pinpoint them.