Wiki
  • Homepage
  • Player's Manual
    • Controls
    • Skills
    • Objects
    • Credits
  • Contributing
    • Getting Started
      • Programs and Files
      • Cloning the GitHub Project
      • Git Structure
      • Submitting Changes
    • Level Design
      • Basic Level Setup
      • Creating Static.tscn
      • Creating Collision.tscn
      • Stage Triggers
        • Using StageTrigger.tscn
        • Camera Triggers
        • Culling Triggers
        • Death Triggers
        • Dialog Triggers
        • Jump Triggers
        • Path Triggers
        • Automation Triggers
        • Drift Triggers
        • Foothold Triggers
        • Platform Triggers
        • Sidle Triggers
      • Stage Objects
      • Placing Objects Along the Path
    • Playtesting
      • General Shortcuts
      • Debug Menu
      • Free Camera Mode
      • Using the Editor for Playtesting
    • Submitting a Bug Report
    • Documentation Style Guide
  • Asset Guidelines
    • Source Files
    • Asset Ripping Reference
      • Original Model Files
    • Asset Editing Reference
      • Editing Environment Models
      • Editing Collision Models
      • All About Curves
      • Exporting Models from Blender
    • Resources Files
      • CameraSettingsResource
    • Miscellaneous Notes
  • Godot Guidelines
    • File Guides
      • File Structure
      • Naming Files
    • Project Settings
      • Tag Reference
      • Layer Reference
    • Particle Effects
    • Audio
  • CODE GUIDELINES
    • Language Specifications
    • Formatting
    • General guidelines
    • Attributes
    • Floating Point Numbers
Powered by GitBook
On this page
  • Bug Reporting via GitHub
  • Bug Reporting via Discord
  • Bug Reporting Guidelines
  1. Contributing

Submitting a Bug Report

PreviousUsing the Editor for PlaytestingNextDocumentation Style Guide

Last updated 5 months ago

Important: The development may not respond to bug reports submitted on random social media forums (such as the YouTube comments section, Twitter, etc.).

Bug reports are handled either through the or through the community's . To submit a report, please follow the guidelines below.

Bug Reporting via GitHub

  1. Before submitting a report, search through the issues to make sure it isn't a duplicate issue.

  2. Click New Issue.

  3. Click Get Started next to the Bug Report template.

  4. Enter a brief description of the bug in the Title field.

  5. Enter a detailed description in the Message field.

  6. Click Submit New Issue.

Bug Reporting via Discord

  1. Go to the #bug-reports channel.

  2. Click New Post.

  3. Enter a brief description of the bug in the Title field.

  4. Enter a detailed description in the Message field.

  5. (Optional) Attach tags based on what part of the game is broken.

  6. Click Post.

Bug Reporting Guidelines

  • Titles should be brief single sentences that describe the bug. Try to follow the format of "[BUG TYPE] [LOCATION] [ACTION]."

    • DO: "Game Crashes during Sand Oasis' Goal Mission when Stomping on Grindrail."

    • DON'T: Game Crash.

    • If you're using Discord, you can use the tagging system as well.

  • Be specific. Try to avoid vague language like "it" or "that".

    • DO: When Sonic Speed Breaks into the boss, the boss' animations freeze (Repetition is clearer).

    • DON'T: When Sonic hits the boss during a Speed Break, it freezes (what does "it" refer to?).

  • Include as much information as you can in the description.

    • DO: I'm on the latest public release (v0.2.0). In the Rampage mission of Evil Foundry, part of the stage disappears if you back-step at the section right after the catapult.

    • DON'T: Stage disappears (This is too vague to be useful).

    • DON'T: Stage disappears when backstepping (Could work as a bug title, not descriptive enough for the description).

  • Add visuals

    • If at all possible, attach a video (that preferably starts before the bug happens).

    • Attach a screenshot. Use [Windows + Shift + S]. It's on every Windows machine.

    • Even if you can't get a screenshot of the bug itself, TAKE A SCREENSHOT OF WHERE IT HAPPENED.

  • Add Reproduction Steps!!! If the dev team can't reproduce the bug, we can't fix it.

    • If there is no consistent set up, let us know so play-testers can keep an eye out for it in the future.

    • Try to write steps in chronological order using a Numbered List.

  • Proof-read your report. Grammatically poor reports make it incredibly difficult to figure out what you're reporting.

  • Try to be concise. Shorter reports (that still contain all relevant data) are easier to read.

GitHub Issue Tracker
Discord Server