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

DOCUMENTATION: Add instructions to troubleshoot common issues for contributors to CONTRIBUTING.md (#2420)

Browse Source
This commit is contained in:
catloversg
2025-12-16 02:46:58 +07:00
committed by GitHub
parent 2167a92af1
commit c3eb4f9ad6
1 changed files with 10 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
CONTRIBUTING.md
View File

@@ -215,6 +215,16 @@ the following rules:
and relate to the kind of change being implemented. Possible examples
are UI, BUGFIX, SERVERS, NETSCRIPT... You get the idea.
## Troubleshooting common issues
### Unrelated changes in `package-lock.json`
After running `npm install`, if you do not change anything in `package.json` and `package-lock.json` is still changed, you need to update `npm` to the latest version. After that, discard the changes in `package-lock.json`, delete the `node_modules` folder, and run `npm install` again.
### Unrelated failed Jest tests
Some Jest tests fail to run in Node 24. Those tests show a small difference between the expected value ("Snapshot") and the actual value ("Received"). If you do not change anything related to those tests, you can ignore them. This is not a problem with earlier Node versions.
## As a Documenter
To contribute to and view your changes to the BitBurner documentation in-game, you will