Skip to content

Latest commit

 

History

History
62 lines (54 loc) · 5.73 KB

README.md

File metadata and controls

62 lines (54 loc) · 5.73 KB
Raw

Resonite Issues

Issue repository for Resonite. Please log any bug reports, or feature requests here using the appropriate template:

Reporting Requirements

Please ensure the following requirements are met for anything submitted.

FAILING TO FOLLOW THESE REQUIREMENTS MAY RESULT IN YOUR ISSUE GOING UNADDRESSED/BEING CLOSED

  • Use the most recent version of Resonite when replicating your issues.
    • This helps ensure that issues are still relevant and replicable
  • Try to search for existing issues describing your problem before creating a new one
    • If an issue already exists for what you wish to report, please add any additional information to the existing issue instead.
  • Focus on the high-level issue first, not a specific solution, as this lets us approach the problem most efficiently.
    • For example, it's better to say "I have this problem", rather than "Add a component that when this and this happens, it does this".
    • Problems can have many solutions and if your issue describes a very specific solution, you're more likely to get a lot of questions.
    • In Computing, this issue is commonly referred to as the XY Problem
  • Do not request overhauls of systems, focus on the bugs or features you want.
    • Overhauling a particular system is solely a Resonite engineering team decision.
    • If you want us to consider several issues for a single subsystem without specific solutions, you can start a discussion
  • Do not hijack issues for another feature/bug, Make another issue instead.
    • Issues should never have comments similar to "While you're at it, can you also do this?", it will not be considered and will get lost.
  • Try to troubleshoot and isolate the problem first before reporting it.
    • For example, if it is a complex ProtoFlux creation try to identify the specific node/node group that is at fault. Then remove as much as possible from the item/world while still producing the bug.
  • Ensure that the issue happens WITHOUT MODS OR PLUGINS
    • Sometimes mods or plugins can be the source of an issue, so before you submit, make sure it occurs without them.
  • Provide a clean log file from replicating the issue
    • Except for Diagnostic ones, Do not use mods or plugins.
    • Launch the client, Load the replication item/world, Replicate the issue, Exit
  • Use objective, and respectful language for anything submitted.
  • Use a short, but descriptive title, as vague titles
    • For example use instead of "System breaks when used with Other system", instead of "System Issue".
  • Be succinct and to the point, because we tackle a lot of issues.
    • Imagine you have just 30 seconds to explain to us what is wrong.
    • If we need to read long paragraphs or watch long videos to understand an issue, then we are less likely to prioritize it.
  • Be specific when possible, because vague statements can be hard to interpret.
    • For example instead of "It took a long time to finish", say "It took about 30 minutes to finish".
    • For some users, a minute is a long time, and for others, an hour is a short time.
  • Provide accurate updates if something changes with the issue.
    • If occurs more frequently, has additional, or changed replication steps then update us with a comment on the issue.
  • When asked for additional info, try to provide exactly what was asked.
    • There are a variety of technical reasons why we need precisely what we ask for and missing the information may prevent us from progressing on an issue.
  • For example, if we ask to provide a screenshot of something, don't provide a video instead - this makes it harder for us to parse and look through.
  • Do not refer to projects we worked on in the past we're unable to use materials or issues from past projects.

How we prioritize issues

We use several factors when prioritizing issues. If you'd like to learn more and help increase the likelihood that your issue gets addressed, read our HOW_WE_PRIORITIZE document here.

Using Diagnostic mods/plugins

We will accept additional diagnostic data produced by mods specifically made to diagnose a given issue and provide more helpful context and information. In some cases, these might be necessary to demonstrate certain issues, as they might not be visible directly or show in the log or can provide helpful information to help us narrow down the issue faster.

If you want to create and use such a mod/plugin for a report, please ensure the following:

  • The issue must still occur without any mods present - in other words, ensure that the issue is a problem with the vanilla client
  • Please provide the diagnostic data in the issue itself - we will typically not run third party mods or plugins ourselves
  • Providing the source of the mod can be helpful as well to provide more context, even when we don't run it

Thank you for your reports, and feedback.