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

Merge pull request #319 from kopelli/contributor-file

Browse Source 
Contributor file
This commit is contained in:
danielyxie 2018-06-26 15:23:27 -05:00 committed by GitHub
commit c1e54cbf77
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 69 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_.

40
README.md
View File

@ -1,31 +1,35 @@
# Bitburner
Bitburner is a cyberpunk hacking-themed incremental game. The game can be
played [here](https://danielyxie.github.io/bitburner).
Bitburner is a cyberpunk hacking-themed incremental game. The game can be
played at https://danielyxie.github.io/bitburner.
# Documentation
The game's official documentation can be found [here](http://bitburner.readthedocs.io/en/latest/index.html). Please note that
this is still a work-in-progress and is in its early stages.
The game's official documentation can be found on [Read The
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
in /doc/ and then making a pull request with your changes/contributions.
Anyone is welcome to contribute to the documentation by editing the [source
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
The game's wiki can be found [here](http://bitburner.wikia.com/wiki/Bitburner_Wiki).
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.
The game's wiki can be found on [Wikia](http://bitburner.wikia.com/). 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.
# Contribution
There are many ways to contribute to the game. It can be as simple as fixing
a typo, correcting a bug, or improving the UI. For guidance on doing so,
please refer to the [CONTRIBUTING](CONTRIBUTING.md) document.
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.
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.
collaborator, please reach out to @danielyxie to help coordinate the effort.