Added documentation for what to do when game is frozen. Updated CONTRIBUTING.md section about bug reporting

This commit is contained in:
danielyxie 2018-10-24 20:40:07 -05:00
parent e0df6207c1
commit e2b77e7a27
3 changed files with 31 additions and 1 deletions

@ -22,6 +22,9 @@ heard:
The recommended method for reporting a bug is by opening a The recommended method for reporting a bug is by opening a
[Github Issue](https://github.com/danielyxie/bitburner/issues). [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 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). 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 * **Use a clear and descriptive title** for the issue
* **State your browser, your browser's version, and your computer's OS** * **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 * **Provide instructions on how to reproduce the bug** in as much detail
as possible. If you cannot reliably reproduce the bug, then just try as possible. If you cannot reliably reproduce the bug, then just try
your best to explain what was happening when the bug occurred your best to explain what was happening when the bug occurred

26
doc/source/gamefrozen.rst Normal file

@ -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>`_.

@ -23,9 +23,9 @@ secrets that you've been searching for.
Terminal <terminal> Terminal <terminal>
Coding Contracts <codingcontracts> Coding Contracts <codingcontracts>
Keyboard Shortcuts <shortcuts> Keyboard Shortcuts <shortcuts>
Game Frozen or Stuck? <gamefrozen>
Changelog <changelog> Changelog <changelog>
Indices and tables Indices and tables
================== ==================