You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: AGENTS.md
+6-6Lines changed: 6 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,7 @@ TSGolint is a static analysis tool, based on typescript-go, for implementing and
4
4
5
5
## ⚠️ CRITICAL: typescript-go Submodule Warning
6
6
7
-
**DO NOT COMMIT SUBMODULE CHANGES WHEN FINALIZING WORK**
7
+
**DO NOT COMMIT SUBMODULE POINTER CHANGES**
8
8
9
9
The `typescript-go/` directory is a Git submodule that references Microsoft's TypeScript Go port.
10
10
@@ -14,11 +14,11 @@ The `typescript-go/` directory is a Git submodule that references Microsoft's Ty
14
14
- You can freely modify and commit within the `typescript-go/` folder
15
15
- Use normal git commands within the typescript-go directory as needed
16
16
17
-
### Before Finalizing Work
17
+
### Before Creating a TSGolint Commit
18
18
19
-
-Convert any typescript-go changes into patch files in the `patches/` directory
20
-
-**NEVER**commit the submodule pointer changes to the TSGolint repository
21
-
-When you see `modified: typescript-go (new commits)` in git status, do NOT stage/commit this change
19
+
-Check `git status` before committing.
20
+
-**NEVER**stage or commit submodule pointer changes unless explicitly performing a `typescript-go` submodule update.
21
+
-If you are performing a submodule update, make sure to stage and commit the new pointer to the upstream typescript-go commit. MAKE SURE this pointer DOES NOT include the additional patches.
22
22
23
23
### Creating Permanent Changes
24
24
@@ -27,7 +27,7 @@ If you need to modify typescript-go functionality permanently:
27
27
1. Test your changes locally in the typescript-go directory
28
28
2. Create a patch file in `patches/` using `git format-patch`
29
29
3. Document the patch purpose in `patches/README.md`
30
-
4. Reset the typescript-go submodule to its original state
30
+
4. Reset the typescript-go submodule only after the patch has been created and the user has approved, or when the task explicitly requires the patch workflow
31
31
5. The patches are applied during project initialization (`just init`) using `git am --3way --no-gpg-sign ../patches/*.patch`
0 commit comments