From 38dbeeaaa3add0a567bac6014172bf2632895ba8 Mon Sep 17 00:00:00 2001 From: GeckoEidechse <40122905+GeckoEidechse@users.noreply.github.com> Date: Mon, 8 Jan 2024 17:17:22 +0100 Subject: Mention how and why to commit files as `Respawn` (#272) --- docs/development/repositories/northstarmods.md | 9 +++++++++ 1 file changed, 9 insertions(+) (limited to 'docs/development/repositories') 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="" 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. -- cgit v1.2.3