README: Before Creating An Issue

[EdwardJXLi]

Welcome

Hi there! Thanks for checking out ProjectObsidian! Before creating an issue, please consider joining the Discord Server! Most technical discussions will occur there, so if you are interested in helping out, check out Discord first! If you want to report an issue on Github:

Reporting Bugs

When reporting a bug or crash, please include:

• System information
• Obsidian version hash
• Reproduction steps
• Any error or crash logs
• Screenshots (optional, but preferable)

Suggesting Features

• If suggesting a small feature: (Add x command, implement y functionality, etc.)
  • Consider joining the Discord Server and suggesting there.
  • Consider creating a discussion on Github Discussions.
• If the feature is a large feature: (rewrite the backend for x, add a whole new gamemode y, etc.)
  • Join the Discord Server to get updates on whether the feature is already in development
  • Check other Github Issues to make sure it hasn't already been submitted.
  • Create an issue outlining specific details on what features to add.

Asking Questions or for Help

• Consider joining the Discord Server and asking there.
• Consider creating a discussion on Github Discussions.
• (Not Recommended) Create an issue outlining specific details on your concern.