Personal_mirrors/bitburner-src
1
0
Fork 0
mirror of https://github.com/bitburner-official/bitburner-src.git synced 2024-09-16 19:08:34 +02:00
Code Issues Packages Projects Releases Wiki Activity

DOCS: Adding information to CONTRIBUTING.md (#1049)

Browse Source
This commit is contained in:
deansvendsen 2024-01-24 08:18:00 +11:00 committed by GitHub
parent 788a7549da
commit f79470148e
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 8 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
doc/CONTRIBUTING.md
View File

@ -207,9 +207,17 @@ the following rules:
- Ensure you have run `npm run lint` to make sure your changes conform to the - Ensure you have run `npm run lint` to make sure your changes conform to the
rules enforced across the code base. The command will fail if any of the rules enforced across the code base. The command will fail if any of the
linters find a violation. linters find a violation.
- Ensure you have run `npm run format` to make sure your changes conform to the
style guide.
- Also, ensure you have run `npm run test` to make sure your changes pass
the automated tests.
- Do not check in any bundled files (`dist\*.bundle.js`) or the `index.html` - 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 in the root of the repository. These will be updated as part of official
releases. releases.
- The title of your Pull Request will need to be formatted like
`MISC: Reticulated the splines`, where the first word must be capitalised
and relate to the kind of change being implemented. Possible examples
are UI, BUGFIX, SERVERS, NETSCRIPT... You get the idea.
## As a Documenter ## As a Documenter