bitburner-src/CONTRIBUTING.md

Contributing to BitBurner

In General

The game is made better because the community as a whole speaks up about ways to improve the game. Here's some of the ways you can make your voice heard:

• Discord There is a dedicated Discord instance set up for more free-form chats between all members of the community. Regular players, heavy scripters, BitBurner contributors, and everyone in between can be found on the server.
• Github Issues Although the term "issues" can have a negative connotation, they are a means of communicating with the community. A new Issue can be a interesting new feature that you feel would improve the game. It could be an unexpected behavior within the game. Or because the game is about scripting perhaps there is something that is conflicting with the browser's Javascript interaction. So please do not be afraid to open a new issue.

As a Developer

To contribute to BitBurner code, you will need to have NodeJS installed. When installing NodeJS, a utility called npm is installed as well.

Before submitting your code for a pull request, please try to follow these rules:

• Work in a branch forked from dev to isolate the new code
• Ensure you have latest from the game's main repository
• Rebase your branch if necessary
• Run the game locally to test out your changes
• When submitting the pull request, make sure that the base fork is danielyxie/bitburner and the base is dev.

As a Documentor

To contribute to BitBurner documentation, you will need to have Python installed, along with Sphinx.

Before submitting your code for a pull request, please try to follow these rules:

• Work in a branch forked from dev to isolate the new code
• Ensure you have latest from the game's main repository
• Rebase your branch if necessary
• When submitting the pull request, make sure that the base fork is danielyxie/bitburner and the base is dev.