Personal_mirrors/bitburner-src
1
0
Fork 0
mirror of https://github.com/bitburner-official/bitburner-src.git synced 2024-12-19 12:45:45 +01:00
Code Issues Packages Projects Releases Wiki Activity

[doc] Updating CONTRIBUTING

Browse Source
This commit is contained in:
Steven Evans 2018-08-30 11:16:32 -04:00
parent a154d214b7
commit 60ee4f01be
1 changed files with 31 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
CONTRIBUTING.md
View File

@ -57,8 +57,8 @@ You can contact him through:
* 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
@ -88,12 +88,16 @@ the following rules:
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.