summaryrefslogtreecommitdiffstats
path: root/TESTING.md
diff options
context:
space:
mode:
Diffstat (limited to 'TESTING.md')
-rw-r--r--TESTING.md21
1 files changed, 13 insertions, 8 deletions
diff --git a/TESTING.md b/TESTING.md
index 65a078e02..bbbf72a59 100644
--- a/TESTING.md
+++ b/TESTING.md
@@ -1,25 +1,30 @@
-Contributing by testing Cuberite
-===============================
+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`.
+If you would like to help with coding instead, see [GETTING-STARTED.md][1] and [CONTRIBUTING.md][2].
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%3Astatus%2Fingame-testing-needed) label.
+ - Run and test Cuberite. Report issues, bugs, crashes, and stacktraces at the [issue tracker][3]. This is best done in debug mode.
+ - Test unmerged versions (known as branches or Pull Requests) which are marked with the [ingame-testing-needed][4] 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
+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
+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.
+To test unmerged branches, pick one from the ingame-testing-needed list, and follow the download instructions.
If you are familiar with git, you can also fetch and compile the unmerged branch instead.
+
+[1]: https://github.com/cuberite/cuberite/blob/master/GETTING-STARTED.md
+[2]: https://github.com/cuberite/cuberite/blob/master/CONTRIBUTING.md
+[3]: https://github.com/cuberite/cuberite/issues
+[4]: https://github.com/cuberite/cuberite/pulls?q=is%3Aopen+is%3Apr+label%3Astatus%2Fingame-testing-needed