From 1ca181c4dde7780f85cf86f569a4014b406ad751 Mon Sep 17 00:00:00 2001 From: Emmanuel Ferdman Date: Thu, 26 Jun 2025 15:59:02 +0300 Subject: [PATCH] DOCUMENTATION: Update contribution guide (#2214) --- CONTRIBUTING.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 150eb3198..ee4124b2b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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_.