9c09e44db2
As it currently stands, bringing in TSLint with *all* rules enabled by default and override each as we go. This means that as we upgrade and bring in new rules we might start seeing new rules that the code violates. Because all the rules are enabled by default, the choice to explicitly disable/relax rules can be discussed as part of PRs. This also brought in strict type checking. This means we shouldn't be relying on truthy/falsey value coercion. It also means that we will likely need to create some type definition files or port certain files over. That...will be a bit tedious, but will make the codebase better as a whole. |
||
|---|---|---|
| css | ||
| dist | ||
| doc | ||
| netscript_tests | ||
| src | ||
| tests | ||
| utils | ||
| .gitattributes | ||
| .gitignore | ||
| index.html | ||
| license.txt | ||
| netscript.js | ||
| package-lock.json | ||
| package.json | ||
| README.md | ||
| tsconfig.json | ||
| tslint.json | ||
| webpack.config.js | ||
Bitburner
Bitburner is a cyberpunk hacking-themed incremental game. The game can be played here.
Documentation
The game's official documentation can be found here. Please note that this is still a work-in-progress and is in its early stages.
The documentation is created using Sphinx and is hosted on Read The Docs.
Anyone is welcome to contribute to the documentation by editing the source files in /doc/ and then making a pull request with your changes/contributions.
Wiki
The game's wiki can be found here. Please note that the wiki is in the process of being deprecated. Eventually all of the wiki content will be moved into the Read The Docs documentation.
Contributing
If you would like to make any small change or addition to the game, you may go ahead and do so by submitting a pull request.
You will retain all ownership of the Copyright of any contributions you make, and will have the same rights to use or license your contributions. By submitting a pull request you agree to grant me perpetual, worldwide, non-exclusive, transferable, royalty-free, and irrevocable rights to use, publish, and distribute your contributions to the project. A formal Contributor's License Agreement will be drawn up in the future.
If you would like to make significant contributions to the project as a collaborator, please message me privately.