From e2b77e7a27dd505bca9ca1c6634d6ece8a30c2e2 Mon Sep 17 00:00:00 2001
From: danielyxie <dxie@g.hmc.edu>
Date: Wed, 24 Oct 2018 20:40:07 -0500
Subject: [PATCH] Added documentation for what to do when game is frozen.
 Updated CONTRIBUTING.md section about bug reporting

---
 CONTRIBUTING.md           |  4 ++++
 doc/source/gamefrozen.rst | 26 ++++++++++++++++++++++++++
 doc/source/index.rst      |  2 +-
 3 files changed, 31 insertions(+), 1 deletion(-)
 create mode 100644 doc/source/gamefrozen.rst

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index e965b1e63..a804aad5c 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -22,6 +22,9 @@ heard:
 The recommended method for reporting a bug is by opening a
 [Github Issue](https://github.com/danielyxie/bitburner/issues).
 
+Alternatively, you can post a bug by creating a post on the
+[game's subreddit](https://www.reddit.com/r/Bitburner/).
+
 Before submitting a bug report, please check to make sure the bug has not
 already been reported as an [Issue](https://github.com/danielyxie/bitburner/issues).
 
@@ -29,6 +32,7 @@ already been reported as an [Issue](https://github.com/danielyxie/bitburner/issu
 
   * **Use a clear and descriptive title** for the issue
   * **State your browser, your browser's version, and your computer's OS**
+  * **Attach your save file**, if you think it would help solve the issue
   * **Provide instructions on how to reproduce the bug** in as much detail
     as possible. If you cannot reliably reproduce the bug, then just try
     your best to explain what was happening when the bug occurred
diff --git a/doc/source/gamefrozen.rst b/doc/source/gamefrozen.rst
new file mode 100644
index 000000000..7b29bb448
--- /dev/null
+++ b/doc/source/gamefrozen.rst
@@ -0,0 +1,26 @@
+Game Frozen or Stuck?
+=====================
+
+Infinite Loop in NetscriptJS
+----------------------------
+
+If your game is frozen or stuck in any way, then the most likely culprit is an
+infinitely running loop in :ref:`netscriptjs`. To get past the freezing, run the game with
+`?noScripts` in the URL:
+
+`https://danielyxie.github.io/bitburner/?noScripts <https://danielyxie.github.io/bitburner/?noScripts>`_
+
+Then, to fix your script, make sure you have a sleep or any other timed function like `hack()` or
+`grow()` in any infinite loops::
+
+    while(true) {
+        // This is an infinite loop that does something
+        ...
+        await ns.sleep(1000); // Add a 1s sleep to prevent freezing
+    }
+
+Bug
+---
+
+Otherwise, the game is probably frozen/stuck due to a bug. To report a bug, follow
+the guidelines `here <https://github.com/danielyxie/bitburner/blob/master/CONTRIBUTING.md#reporting-bugs>`_.
diff --git a/doc/source/index.rst b/doc/source/index.rst
index bdd008747..b0877c39e 100644
--- a/doc/source/index.rst
+++ b/doc/source/index.rst
@@ -23,9 +23,9 @@ secrets that you've been searching for.
     Terminal <terminal>
     Coding Contracts <codingcontracts>
     Keyboard Shortcuts <shortcuts>
+    Game Frozen or Stuck? <gamefrozen>
     Changelog <changelog>
 
-
 Indices and tables
 ==================