mirror of
https://github.com/bitburner-official/bitburner-src.git
synced 2024-11-18 21:53:50 +01:00
48 lines
2.1 KiB
Markdown
48 lines
2.1 KiB
Markdown
|
#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](https://discordapp.com)
|
||
|
|
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](https://github.com/danielyxie/bitburner/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](https://github.com/danielyxie/bitburner/issues/new).
|
||
|
|
|
||
|
|
##As a Developer
|
||
|
|
To contribute to BitBurner code, you will need to have
|
||
|
|
[NodeJS](https://nodejs.org) 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](danielyxie/bitburner@dev)
|
||
|
|
- 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](http://www.sphinx-doc.org).
|
||
|
|
|
||
|
|
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](danielyxie/bitburner@dev)
|
||
|
|
- Rebase your branch if necessary
|
||
|
|
- When submitting the pull request, make sure that the base fork is
|
||
|
|
_danielyxie/bitburner_ and the base is _dev_.
|