[doc] Updating CONTRIBUTING

This commit is contained in:
Steven Evans 2018-08-30 11:16:32 -04:00
parent a154d214b7
commit 60ee4f01be

@ -17,29 +17,29 @@ heard:
scripting perhaps there is something that is conflicting with the scripting perhaps there is something that is conflicting with the
browser's Javascript interaction. So please do not be afraid to open a browser's Javascript interaction. So please do not be afraid to open a
[new issue](https://github.com/danielyxie/bitburner/issues/new). [new issue](https://github.com/danielyxie/bitburner/issues/new).
## Reporting Bugs
The recommended method for reporting a bug is by opening a
[Github Issue](https://github.com/danielyxie/bitburner/issues).
Before submitting a bug report, please check to make sure the bug has not ## Reporting Bugs
already been reported as an [Issue](https://github.com/danielyxie/bitburner/issues). The recommended method for reporting a bug is by opening a
[Github Issue](https://github.com/danielyxie/bitburner/issues).
Before submitting a bug report, please check to make sure the bug has not
already been reported as an [Issue](https://github.com/danielyxie/bitburner/issues).
#### How to Submit a Good Bug Report #### How to Submit a Good Bug Report
* **Use a clear and descriptive title** for the issue * **Use a clear and descriptive title** for the issue
* **State your browser, your browser's version, and your computer's OS** * **State your browser, your browser's version, and your computer's OS**
* **Provide instructions on how to reproduce the bug** in as much detail * **Provide instructions on how to reproduce the bug** in as much detail
as possible. If you cannot reliably reproduce the bug, then just try as possible. If you cannot reliably reproduce the bug, then just try
your best to explain what was happening when the bug occurred your best to explain what was happening when the bug occurred
* **Provide any scripts** that triggered the bug if the issue is Netscript-related * **Provide any scripts** that triggered the bug if the issue is Netscript-related
* **Open your browser's Dev Console and report any error-related output** * **Open your browser's Dev Console and report any error-related output**
that may be printed there. The Dev Console can be opened on most modern that may be printed there. The Dev Console can be opened on most modern
browsers by pressing F12 browsers by pressing F12
## As a Developer ## As a Developer
Anyone is welcome to contribute to Bitburner code. However, please read Anyone is welcome to contribute to Bitburner code. However, please read
the [license](https://github.com/danielyxie/bitburner/blob/dev/license.txt) the [license](https://github.com/danielyxie/bitburner/blob/dev/license.txt)
and the [readme](https://github.com/danielyxie/bitburner/blob/dev/README.md) and the [readme](https://github.com/danielyxie/bitburner/blob/dev/README.md)
before doing so. before doing so.
@ -48,22 +48,22 @@ To contribute to Bitburner code, you will need to have
called `npm` is installed as well. called `npm` is installed as well.
#### What are you Allowed to Contribute? #### What are you Allowed to Contribute?
Not all code contributions will be accepted. The safest way to ensure Not all code contributions will be accepted. The safest way to ensure
that you don't waste time working on something that gets rejected is to that you don't waste time working on something that gets rejected is to
run your idea(s)/plan(s) past [danielyxie](https://github.com/danielyxie) first. run your idea(s)/plan(s) past [danielyxie](https://github.com/danielyxie) first.
You can contact him through: You can contact him through:
* Github * Github
* Discord * Discord
* [Reddit](https://www.reddit.com/user/chapt3r/) * [Reddit](https://www.reddit.com/user/chapt3r/)
Otherwise, here are some general guidelines for determining what types of changes Otherwise, here are some general guidelines for determining what types of
are okay to contribute: changes are okay to contribute:
##### Contributions that Will Most Likely Be Accepted ##### Contributions that Will Most Likely Be Accepted
* Bug Fixes * Bug Fixes
* Quality-of-Life Changes * Quality-of-Life Changes
* Adding a new, commonly-requested Netscript function * Adding a new, commonly-requested Netscript function
* Fixing or improving UI elements * Fixing or improving UI elements
* Adding game settings/options * Adding game settings/options
* Adding a new Terminal command * Adding a new Terminal command
@ -73,8 +73,8 @@ are okay to contribute:
* Changes that directly affect the game's balance * Changes that directly affect the game's balance
* New gameplay mechanics * New gameplay mechanics
#### Submitting a Pull Request #### Submitting a Pull Request
When submitting a pull request with your code contributions, please abide by When submitting a pull request with your code contributions, please abide by
the following rules: the following rules:
- Work in a branch forked from `dev` to isolate the new code - Work in a branch forked from `dev` to isolate the new code
@ -86,14 +86,18 @@ the following rules:
_danielyxie/bitburner_ and the base is _dev_. _danielyxie/bitburner_ and the base is _dev_.
- If your changes affect the game's UI, attach some screenshots or GIFs showing - If your changes affect the game's UI, attach some screenshots or GIFs showing
the changes to the UI the changes to the UI
- If your changes affect Netscript, provide some - If your changes affect Netscript, provide some
scripts that can be used to test the Netscript changes. scripts that can be used to test the Netscript changes.
- Do not check in any bundled files (`dist\*.bundle.js`). These will be - Ensure you have run `npm run lint` to make sure your changes conform to the
updated as part of official releases. rules enforced across the code base. The command will fail if any of the
linters find a violation.
- Do not check in any bundled files (`dist\*.bundle.js`) or the `index.html`
in the root of the repository. These will be updated as part of official
releases.
## As a Documentor ## As a Documentor
To contribute to BitBurner documentation, you will need to have Python To contribute to and view your changes to the BitBurner documentation, you will
installed, along with [Sphinx](http://www.sphinx-doc.org). 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 Before submitting your code for a pull request, please try to follow these
rules: rules:
@ -103,3 +107,5 @@ rules:
- Rebase your branch if necessary - Rebase your branch if necessary
- When submitting the pull request, make sure that the base fork is - When submitting the pull request, make sure that the base fork is
_danielyxie/bitburner_ and the base is _dev_. _danielyxie/bitburner_ and the base is _dev_.
- Do not check in any generated files under `doc\`. The documentation is built
automatically by ReadTheDocs.