How to report a bug

Have you found some errors that you want to report to me?
Perfect, you need to know that I need to be able to replicate that bug, for that, I invite you to follow some steps before send the report 😉

  1. Enable the debug log (really important)
  2. Replicate the bug
  3. Group up the files
  4. Send the report!

Enable the debug log

Nothing hard, you just need to replace these options inside your configuration file!
Go into your config.yml at the line 19~, where log options starts, and edit these like that:

# ...
logging:
  # Enable debug messages
  debug: true
  save-file:
    # Save to file log messages
    enable: true
    # ...

After doing that, be sure you are collecting the log output (Default output: log.txt).

Replicate the bug

Now, take a note about what are you doing so you can write the procedure into the report.

If the bug has been occurred, we should have caught that.

Group up files

Now prepare your things, these should be:

  • The file log.txt
  • The procedure to perform the bug
  • Your config.yml and parties.yml
  • It depends on the bug but sometimes I need to re-create exactly your Parties configuration, so if needed, group up the database file and the messages.yml too

Send the report!

You can: