2022-01-15 21:36:34 +01:00
|
|
|
# DELETE THIS AFTER READING
|
|
|
|
|
|
2022-05-19 08:48:50 +02:00
|
|
|
# READ CONTRIBUTING.md
|
|
|
|
|
|
2022-04-14 18:16:03 +02:00
|
|
|
# PR title
|
|
|
|
|
|
|
|
|
|
Formatted as such:
|
2023-02-12 08:22:07 +01:00
|
|
|
CATEGORY: Change Description
|
2022-04-14 18:16:03 +02:00
|
|
|
|
2023-02-12 08:22:07 +01:00
|
|
|
CATEGORY is something like "API", "UI", "MISC", "STANEK", etc, and must be uppercase.
|
|
|
|
|
Change Description is what you'd tell a non-contributor to convey what is changed.
|
2022-04-14 18:16:03 +02:00
|
|
|
|
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.
|
2022-09-23 15:38:15 +02:00
|
|
|
If your PR should close the issue when it is merged in, use `fixes #xyz` or `closes #xyz` like this:
|
|
|
|
|
|
|
|
|
|
closes #xxxx
|
|
|
|
|
closes #yyyy
|
|
|
|
|
|
|
|
|
|
It'll automate the process.
|
2022-04-15 16:58:40 +02:00
|
|
|
|
2022-01-14 20:28:09 +01:00
|
|
|
# Documentation
|
|
|
|
|
|
2023-02-12 08:22:07 +01:00
|
|
|
- If your PR includes ns API function changes, do not manually modify markdown files.
|
|
|
|
|
- Instead, you can run `npm run doc` to autogenerate new markdown files that reflect your submitted API changes.
|
2022-01-14 20:28:09 +01:00
|
|
|
|
|
|
|
|
# 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.
|
