Personal_mirrors/bitburner-src
1
0
Fork 0
mirror of https://github.com/bitburner-official/bitburner-src.git synced 2024-11-09 17:23:53 +01:00
Code Issues Packages Projects Releases Wiki Activity

[doc] Adding CONTRIBUTING

Browse Source
This commit is contained in:
Steven Evans 2018-06-21 10:04:02 -04:00
parent 18d4e2bd2a
commit 729515830d
2 changed files with 73 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

47
CONTRIBUTING.md Normal file
View File

@ -0,0 +1,47 @@
#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_.

44
README.md
View File

@ -1,31 +1,39 @@
# Bitburner # Bitburner
Bitburner is a cyberpunk hacking-themed incremental game. The game can be Bitburner is a cyberpunk hacking-themed incremental game. The game can be
played [here](https://danielyxie.github.io/bitburner). played at https://danielyxie.github.io/bitburner.
# Documentation # Documentation
The game's official documentation can be found [here](http://bitburner.readthedocs.io/en/latest/index.html). Please note that The game's official documentation can be found on [Read The
this is still a work-in-progress and is in its early stages. Docs](http://bitburner.readthedocs.io/). 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. The documentation is created using [Sphinx](http://www.sphinx-doc.org).
Anyone is welcome to contribute to the documentation by editing the source files Anyone is welcome to contribute to the documentation by editing the [source
in /doc/ and then making a pull request with your changes/contributions. files](/doc/source) and then making a pull request with your contributions.
For further guidance, please refer to the "As A Documentor" section of
[CONTRIBUTING](CONTRIBUTING.md).
# Wiki # Wiki
The game's wiki can be found [here](http://bitburner.wikia.com/wiki/Bitburner_Wiki). The game's wiki can be found on [Wikia](http://bitburner.wikia.com/). Please
Please note that the wiki is in the process of being deprecated. Eventually all of the note that the wiki is in the process of being deprecated. Eventually all of
wiki content will be moved into the Read The Docs documentation. the wiki content will be moved into the Read The Docs documentation.
# Contributing # Contribution
If you would like to make any small change or addition to the game, you may go ahead There are many ways to contribute to the game. It can be as simple as fixing
and do so by submitting a pull request. a typo
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. For guidance on doing so,
please refer to the [CONTRIBUTING](CONTRIBUTING.md) document in this
repository.
You will retain all ownership of the Copyright of any contributions you make, 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 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, submitting a pull request you agree to grant me perpetual, worldwide,
transferable, royalty-free, and irrevocable rights to use, publish, and distribute non-exclusive, transferable, royalty-free, and irrevocable rights to use,
your contributions to the project. A formal Contributor's License Agreement publish, and distribute your contributions to the project. A formal
will be drawn up in the future. Contributor's License Agreement will be drawn up in the future.
If you would like to make significant contributions to the project as a If you would like to make significant contributions to the project as a
collaborator, please message me privately. collaborator, please reach out to @danielyxie to help coordinate the effort.