October 22, 2017, 07:41:59 PM

Author Topic: Bug Template: Guide to Writing a Report  (Read 4565 times)

orbitmoria

  • Hero Member
  • *****
  • Posts: 946
  • All they do is dance!
    • View Profile
Bug Template: Guide to Writing a Report
« on: February 02, 2013, 01:59:31 AM »
To help the developer fix bugs, I'd encourage players to use this template to write bug reports.

If the Save Game is too large to attach to Bugzilla, please use the Dropbox to upload them.

===BUG TEMPLATE===

Title:
An easy to understand title using "keywords" for search results.

Summary:

Describe the bug in detail, using terminology from the Game.

Steps to Reproduce:

1. Start Gnomoria and...
2. Then...
3. And...

Result:

Describe the "problem" that occurs when you follow the Steps listed.

Notes:
Include any information not listed above, like links to your Save Game.

=====

It is not a requirement to use this template, but it is a helpful guide.  :)

Mythrrinthael

  • Hero Member
  • *****
  • Posts: 841
  • I saw what you did there!
    • View Profile
Re: Bug Template: Guide to Writing a Report
« Reply #1 on: February 02, 2013, 03:00:44 AM »
*cough* I don't think many people are going to notice or even care, really.

orbitmoria

  • Hero Member
  • *****
  • Posts: 946
  • All they do is dance!
    • View Profile
Re: Bug Template: Guide to Writing a Report
« Reply #2 on: February 02, 2013, 02:43:34 PM »
*cough* I don't think many people are going to notice or even care, really.

Perhaps, but having a template useful for people who do care.

asads1978

  • Newbie
  • *
  • Posts: 2
    • View Profile
Re: Bug Template: Guide to Writing a Report
« Reply #3 on: February 11, 2013, 04:36:46 AM »
Noticed and cared.  Would be useful if this link pops up on bugzilla before you post.

Lonestar51

  • Jr. Member
  • **
  • Posts: 93
    • View Profile
Re: Bug Template: Guide to Writing a Report
« Reply #4 on: February 11, 2013, 06:46:37 AM »
*cough* not a moderator, but... maybe this guide would make more sense in the "bug reports" forum. Possibly even as a sticky. *cough*

regarding the guide itself: I like the template.  :D It is not too complicated, and it captures the most critical information quite nicely.

Mythrrinthael

  • Hero Member
  • *****
  • Posts: 841
  • I saw what you did there!
    • View Profile
Re: Bug Template: Guide to Writing a Report
« Reply #5 on: February 12, 2013, 09:22:25 AM »
I suspect nobody noticed I have an interactive cough. It was a named link to Robob0b's very own Bug Report sticky that a lot of people happily ignored. It's why I made such a flippant post; anyone who noticed this thread cannot have missed the sticky that's already there.

orbitmoria

  • Hero Member
  • *****
  • Posts: 946
  • All they do is dance!
    • View Profile
Re: Bug Template: Guide to Writing a Report
« Reply #6 on: February 12, 2013, 09:58:49 AM »
This thread is linked to my signature, like Merry76's Dropbox is linked to his.

It mainly helps me, when helping someone else write a bug. I hope people find it useful though.  :)

syneris

  • Sr. Member
  • ****
  • Posts: 428
    • View Profile
Re: Bug Template: Guide to Writing a Report
« Reply #7 on: February 13, 2013, 02:26:21 PM »
I suspect nobody noticed I have an interactive cough. It was a named link to Robob0b's very own Bug Report sticky that a lot of people happily ignored. It's why I made such a flippant post; anyone who noticed this thread cannot have missed the sticky that's already there.


I did not notice. Perhaps it's the forum theme or my browser, but the color change for the link is barely visible and it is not underlined without hovering over.

Lonestar51

  • Jr. Member
  • **
  • Posts: 93
    • View Profile
Re: Bug Template: Guide to Writing a Report
« Reply #8 on: February 14, 2013, 12:22:29 AM »
I suspect nobody noticed I have an interactive cough.

I sure did not notice. Like syneris I found nothing which did prompt me to expect an link there, it only becomes clear on mouseover.

Anyway, after comparing the versions from robobob and from orbitmoria, I like the version from orbitmoria better. The important points are the same, more or less, but the structure is more clear. (That said, robobob needs to read the bug reports, so his views cannot be entirely discounted...  ;) )