Topic: Site Bugs & Features Guidelines + Template

Last updated 7/27/2016 8:53 PM CST

Greetings! The team has decided upon sorting feature requests and bug reports into a single category instead of two different threads. This will be cleaner and easier to read for developers and users. Naturally we want to have guidelines so it is easier to organize it all and prevent repeats. So check out this forum before making any new threads.

After reading this, you may use this link to make a new request or report.

NOTICE!

PLEASE NOTE THAT ALL SECURITY BUGS MUST BE REPORTED TO [email protected] DO NOT REPORT THEM THROUGH FORUMS/BLIPS/DMAIL/COMMENTS/TICKETS/ETC.[/b]Be sure to check for existing threads first! If one does exist, post what findings you have on it in said thread.ONLY ONE BUG OR FEATURE PER THREAD! Only exception is a host of similar features (like adding new DMail features) as one request.

Here is the overview for thread status tags.
[Bug]

- All users post bugs with this in front of the title. "[Bug] Favorites don't save properly" is an example.

[Bug/Invalid]

- Should the developers be unable to repeat the bug or it is an invalid report, it will be marked invalid. Invalid threads will then be closed. "[Bug/Invalid] Threads rotate 69 degrees every mouse movement" is an example. (unless there's a future April fools planned...)

[Bug/Confirmed]

- Should the developers be able to repeat the bug and it is a valid report, it will be marked confirmed. During this status it will be in the backlog and worked on when a developer finds time. "[Bug/Confirmed] Thread creation doesn't allow stick/lock upon creation" is an example.

[Bug/Fixed]

- Developers have been able to fix the bug and will mark it as such. The thread will also be closed a week later when the status changes. This allows for others to confirm it has been fixed or add more to it. "[Bug/Fixed] Thread creation doesn't allow stick/lock upon creation" is an example.

[Feature]

- All users post feature requests with this in front of the title. "[Feature] Categories show its description like threads" is an example.

[Feature/Denied]

- Should the developers decide against it, it will be denied. Denied threads will then be closed. "[Feature/Denied] If your name is Scrydan, you get free cheesecake" is an example. (no free cheesecake for me!)

[Feature/Approved]

- Should the developers decide to be for it, it will be approved. During this status it will be in the backlog and worked on when a developer finds time. "[Feature/Approved] Categories show its description like threads" is an example.

[Feature/Implemented]

- Developers have been able to implement the feature and will mark it as such. The thread will also be closed a week later when the status changes. This allows for others to discuss it a bit longer. "[Feature/Implemented] Categories show its description like threads" is an example.

That being said, the title is only the first part. The body of your report will be important.

Bug reports -MUST- include the following in these guidelines:
  • Bug overview description.
  • What part(s) of the site page(s) are affected?
  • What is the expected behavior?
  • What actual behavior is given instead?
  • Time of incident (if applicable).
  • Can you reproduce the bug every time?
  • What steps did you take to replicate this bug?
  • Errors or other messages returned (if any).
Example Report

Bug overview description.
Thread creation doesn't allow stick/lock upon creation as a moderator or admin.

What part(s) of the site page(s) are affected?
Forums, submit thread

What is the expected behavior?
Threads with "Sticky" checked or "Locked" checked will have those respectively done for the thread.

What actual behavior is given instead?
"Sticky" checks and "Locked" checks are ignored.

Time of incident (if applicable).
7/11/2016 7:00 PM CST

Can you reproduce the bug every time?
Yes. Any time stickies or locks are attempted upon creation of thread.

What steps did you take to replicate this bug?
Go to forums and then create a thread. Check any of the option checkboxs and then submit. Thread will still be a normal thread in the listing.

Errors or other messages returned (if any).
N/A

Copy Template
[b]Bug overview description.[/b]
[b]What part(s) of the site page(s) are affected?[/b]
[b]What is the expected behavior?[/b]
[b]What actual behavior is given instead?[/b]
[b]Time of incident (if applicable).[/b]
[b]Can you reproduce the bug every time?[/b]
[b]What steps did you take to replicate this bug?[/b]
[b]Errors or other messages returned (if any).[/b]

The more details you give us, the more details we have to work with to fix that bug as soon as possible. This is why we are now asking for approximate time of incident as well as how often it happens. It may have been a slight hiccup resulting from something temporarily, but anything given will help us.

Feature requests -MUST- include the following in these guidelines:
  • Requested feature overview description.
  • Why would it be useful?
  • What part(s) of the site page(s) are affected?
Example Request

Requested feature overview description.
Categories in forum listing on index show its description like threads.

Why would it be useful?
It'd allow users to see the description with HTML rather than appear only when you hover with a mouse in a big character blob with the title attribute. The description would popup if you click a button next to the category in question to bring it up similarly to changing category while posting a thread.

What part(s) of the site page(s) are affected?
Forums, index

Copy Template
[b]Requested feature overview description.[/b]
[b]Why would it be useful?[/b]
[b]What part(s) of the site page(s) are affected?[/b]

The more details you give us, the more details we have to work with to get an idea of what feature you wish to implement. You may even make a mock up image posted of what it'd look like if you are so inclined. The clearer you make your request for us, the higher the chance we will be able to understand and work on it.

Any user who makes threads not following the rules will shortly have their thread locked after a warning.

Updated by Millcore