felixfoertsch/bitburner-src
1
0
Fork 0
mirror of https://github.com/bitburner-official/bitburner-src.git synced 2026-04-16 14:28:36 +02:00
Code Issues Packages Projects Releases Wiki Activity

DOCUMENTATION: Update contribution guide (#2214)

Browse Source
This commit is contained in:
Emmanuel Ferdman
2025-06-26 15:59:02 +03:00
committed by GitHub
parent e3968a1fb9
commit 1ca181c4dd
1 changed files with 3 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
CONTRIBUTING.md
View File

@@ -197,7 +197,7 @@ the following rules:
- Work in a branch forked from `dev` to isolate the new code.
- Ensure you have the latest from the [game's main
repository](../../../tree/dev).
repository](../../tree/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
@@ -226,7 +226,7 @@ the following rules:
To contribute to and view your changes to the BitBurner documentation in-game, you will
need to edit the files in [this folder](https://github.com/bitburner-official/bitburner-src/tree/dev/src/Documentation/doc)
To make change to the [in-game documentation](../markdown/bitburner.md), you will need to modify the [TypeScript definitions](../src/ScriptEditor/NetscriptDefinitions.d.ts), not the Markdown files.
To make change to the [in-game documentation](./markdown/bitburner.md), you will need to modify the [TypeScript definitions](./src/ScriptEditor/NetscriptDefinitions.d.ts), not the Markdown files.
We are using [API Extractor](https://api-extractor.com/pages/tsdoc/doc_comment_syntax/) (tsdoc hints) to generate the Markdown doc. Make your changes to the TypeScript definitions and then run `npm run doc`.
@@ -235,7 +235,7 @@ rules:
- Work in a branch forked from `dev` to isolate the new code.
- Ensure you have the latest from the [game's main
repository](../../../tree/dev).
repository](../../tree/dev).
- Rebase your branch if necessary.
- When submitting the pull request, make sure that the base fork is
_bitburner-official/bitburner-src_ and the base is _dev_.