diff --git a/README.md b/README.md index 63d5467..5d8a0d5 100644 --- a/README.md +++ b/README.md @@ -117,7 +117,7 @@ server.on('login', function(client) { ## Documentation -See [doc](doc/README.md) +See [doc](docs/API.md) ## Testing diff --git a/doc/README.md b/docs/API.md similarity index 100% rename from doc/README.md rename to docs/API.md diff --git a/docs/issue_template.md b/docs/issue_template.md new file mode 100644 index 0000000..65ecfa2 --- /dev/null +++ b/docs/issue_template.md @@ -0,0 +1,16 @@ +If you are reporting a bug please report on these points : + +* what you want to do (the objective in english) +* what you tried (the code) +* what happened +* what you expected to happen + +In particular it will be useful to provide these informations : + +* what happens when using a node-minecraft-protocol example? +* what minecraft-protocol version? +* what server version? +* which server? (spigot, paper, vanilla, any particular plugins ?) +* what's the output of DEBUG="minecraft-protocol" node your_script.js ? +* what's the error msg? +* what script is used (full code)?