diff options
| author | GeckoEidechse <40122905+GeckoEidechse@users.noreply.github.com> | 2024-01-08 17:17:22 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2024-01-08 17:17:22 +0100 |
| commit | 38dbeeaaa3add0a567bac6014172bf2632895ba8 (patch) | |
| tree | 6cf63c01bec7790ca515a53d58e2e14ff2c13018 | |
| parent | 441c3f33d08136c92fcdebfa595df0895b0bdb39 (diff) | |
| download | NorthstarWiki-38dbeeaaa3add0a567bac6014172bf2632895ba8.tar.gz NorthstarWiki-38dbeeaaa3add0a567bac6014172bf2632895ba8.zip | |
Mention how and why to commit files as `Respawn` (#272)
| -rw-r--r-- | docs/development/repositories/northstarmods.md | 9 |
1 files changed, 9 insertions, 0 deletions
diff --git a/docs/development/repositories/northstarmods.md b/docs/development/repositories/northstarmods.md index 1798661..40ea4f0 100644 --- a/docs/development/repositories/northstarmods.md +++ b/docs/development/repositories/northstarmods.md @@ -5,3 +5,12 @@ description: Core squirrel mods # NorthstarMods TODO + +When adding new Sqirrel script source files that are from the base game, make sure to commit the unmodified file first. +In particular, on `main` they should committed as `Respawn` with the email address `respawn@northstar.tf`. + +```sh +git -c user.name="Respawn" -c user.email="<respawn@northstar.tf>" commit -m "Add SQUIRREL_FILE.nut from VPK_NAME" +``` + +This process is done to later leverage the power of `git blame` to see who authored a particular code line which assists with better understanding changes in the codebase. |