Skip to content
This repository has been archived by the owner on Apr 19, 2021. It is now read-only.

Issue Reporting Guidelines

Jump to bottom
Aaron Salyer edited this page Feb 19, 2018 · 4 revisions

Issue Reporting Guidelines

These guidelines MUST be followed when submitting an issue on GitHub. We will try to simplify this process as much as possible but we cannot fix problems without a minimum amount of ACCURATE INFORMATION. A properly completed example can be found here:

https://github.com/RevivalPMMP/PureEntitiesX/issues/248

Before submitting any issue:
PureEntitiesX is being developed to target specific versions of PocketMine-MP. Each release will include information for what version of PocketMine-MP was targeted. If you are not using the targeted version of PocketMine-MP, you will need to try using that version first. Once you've tested with the target version, search the current issues to see if any existing problem is similar or the same as the problem you are having. If you find something that is the same or similar to the problem you are having, comment in that issue where possible. Otherwise, gather as much of the following as possible and submit a new issue.

When Submitting an Issue
Code blocks are necessary when pasting information from the console or logs directly into the issue. If you aren't sure how to use code blocks, include a copy of the log that shows the error instead of pasting it into the report.

ABSOLUTELY REQUIRED

Failure to provide any information from this list will result in the issue being closed as 'Invalid'.

  • PureEntitesX Version.
  • Where you downloaded PureEntitesX from. (Copies of PureEntitesX that do not come from official sources will be ignored.)
  • PocketMine-MP Version. (We do not support any other server software.)
  • Supporting error logs or a DETAILED DESCRIPTION of the problem.

HIGHLY RECOMMENDED

If these items are not provided, you issue may be marked with a low priority and take longer to resolve.

  • PHP Version Number
  • Other Plugins Installed
  • Steps To Reproduce The Issue

Other Helpful Information.

These items can be helpful in some situations but won't directly impact getting your issue resolved unless specifically requested:

  • Operating system the server is run on.
  • Average number of clients connected to the server.
  • A copy of your config.yml file from the plugins/PureEntitesX folder.

If you have questions, check our FAQ:
https://github.com/RevivalPMMP/PureEntitiesX/wiki/Frequently-Asked-Questions-(FAQ)

or get in touch with us on Gitter:
Join the chat at https://gitter.im/RevivalPMMP/PureEntitiesX

Clone this wiki locally