Spherical forums

Sphere Development => Sphere Support => Topic started by: N E O on May 21, 2013, 05:38:54 pm

Title: IMPORTANT: Reporting issues? Follow these guidelines!
Post by: N E O on May 21, 2013, 05:38:54 pm
Given that there's some actual development progress being made on all fronts, I'd like to take a moment to recommend some good practices for forum users reporting issues.

Prefix your thread title with the thing you're reporting on in brackets (the square ones, [ ], and no spaces) and all-caps.

After the bracketed thing, put the operating system in parentheses (the round ones, ( ), and no spaces) and all-caps.

Try to be succinct and descriptive in your title. "Map engine crash on obstruction check" is way easier to figure out at a glance than "Map crashes" or "Crash!"

Try to have a screenshot or link to a video of the problem happening. If we can see it happening we can better determine if it's the engine or simply your script.

If you get an error message, post it. When the engine or editor legitimately crash, the OS will spit out a bunch of information for debuggers. Give this to us please! If the engine simply errors out (a black screen with an error message), it's a problem with a script or resource instead and should be handled accordingly.

Remember, Sphere is open-source and is on GitHub (https://github.com/sphere-group) so if you also want to contribute a patch to any of our repositories feel free to do a pull request there. The source is also hosted on Sourceforge (https://sourceforge.net/projects/sphere) but it's way easier to manage it on GitHub.