summaryrefslogtreecommitdiffstats
path: root/TESTING.md
diff options
context:
space:
mode:
authorLogicParrot <LogicParrot@users.noreply.github.com>2016-02-19 14:40:37 +0100
committerLogicParrot <LogicParrot@users.noreply.github.com>2016-02-19 14:41:24 +0100
commit5e182a01f75ce5bee9732bbde9144a6ee416fbc8 (patch)
tree5bbe0c68c6a3c6643c134f1c61421229ff3486bb /TESTING.md
parentMerge pull request #2986 from LogicParrot/entityDestroy_approach4 (diff)
downloadcuberite-5e182a01f75ce5bee9732bbde9144a6ee416fbc8.tar
cuberite-5e182a01f75ce5bee9732bbde9144a6ee416fbc8.tar.gz
cuberite-5e182a01f75ce5bee9732bbde9144a6ee416fbc8.tar.bz2
cuberite-5e182a01f75ce5bee9732bbde9144a6ee416fbc8.tar.lz
cuberite-5e182a01f75ce5bee9732bbde9144a6ee416fbc8.tar.xz
cuberite-5e182a01f75ce5bee9732bbde9144a6ee416fbc8.tar.zst
cuberite-5e182a01f75ce5bee9732bbde9144a6ee416fbc8.zip
Diffstat (limited to '')
-rw-r--r--TESTING.md25
1 files changed, 25 insertions, 0 deletions
diff --git a/TESTING.md b/TESTING.md
new file mode 100644
index 000000000..1440a8032
--- /dev/null
+++ b/TESTING.md
@@ -0,0 +1,25 @@
+Contributing by testing Cuberite
+===============================
+
+You can help us even if you are not a programmer! This document explains how.
+If you would like to help with coding instead, see `README.md` and `GETTING-STARTING.md`.
+
+Here are things you can help with without being a programmer:
+ - Run and test Cuberite. Report issues, bugs, crashes, and stacktraces at the [issue tracker](https://github.com/cuberite/cuberite/issues). This is best done in debug mode.
+ - Test unmerged versions (known as branches or Pull Requests) which are marked with the [ingame-testing-needed](https://github.com/cuberite/cuberite/pulls?q=is%3Aopen+is%3Apr+label%3Aingame-testing-needed) label.
+ Note that code marked with `ingame-testing-needed` is not always available, and sometimes the above list will be empty.
+
+Please use the issue tracker search feature and make sure your issue has not been reported before!
+
+Obtaining Debug builds
+----------------------
+
+When testing Cuberite, debug builds are preferred because they output detailed info about the problem that had occured at the server console.
+Currently, we do not provide debug builds. You will have to compile Cuberite yourself to obtain them. See the compilation instructions.
+You can also test with regular builds.
+
+Testing unmerged pull requests
+------------------------------
+
+To test unmerged branches, pick one from the [ingame-testing-needed](https://github.com/cuberite/cuberite/pulls?q=is%3Aopen+is%3Apr+label%3Aingame-testing-needed) list, and follow the download instructions.
+If you are familiar with git, you can also fetch and compile the unmerged branch instead.