2022-01-15 21:36:34 +01:00
|
|
|
# DELETE THIS AFTER READING
|
|
|
|
|
|
2022-04-14 18:16:03 +02:00
|
|
|
# PR title
|
|
|
|
|
|
|
|
|
|
Formatted as such:
|
|
|
|
|
SECTION: FIX #xzyw PLAYER DESCRIPTION
|
|
|
|
|
|
|
|
|
|
SECTION is something like "API", "UI", "MISC", "STANEK", "CORPORATION"
|
|
|
|
|
FIX #xyzw is the issue number, if any
|
|
|
|
|
PLAYER DESCRIPTION is what you'd tell a non-contributor to convey what is changed.
|
|
|
|
|
|
2022-04-15 16:58:40 +02:00
|
|
|
# Linked issues
|
|
|
|
|
|
|
|
|
|
If your pull request is related to a git issue, please link it in the description using #xyz.
|
|
|
|
|
If your PR should close the issue when it is merged in, use `fixes #xyz` or `closes #xyz`. It'll automate the process.
|
|
|
|
|
|
2022-01-14 20:28:09 +01:00
|
|
|
# Documentation
|
|
|
|
|
|
|
|
|
|
- DO NOT CHANGE any markdown/\*.md, these files are autogenerated from NetscriptDefinitions.d.ts and will be overwritten
|
|
|
|
|
- DO NOT re-generate the documentation, makes it harder to review.
|
|
|
|
|
|
|
|
|
|
# Bug fix
|
|
|
|
|
|
|
|
|
|
- Include how it was tested
|
|
|
|
|
- Include screenshot / gif (if possible)
|
2022-04-07 01:36:35 +02:00
|
|
|
|
|
|
|
|
Make sure you run `npm run format` and `npm run lint` before pushing.
|
