gsadmin/KoalaSync
1
0
Fork 0
mirror of https://github.com/Shik3i/KoalaSync.git synced 2026-08-18 15:23:13 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs(shared): add strict warning headers and README to prevent out-of-sync edits

Browse Source
This commit is contained in:
Timo
2026-04-23 22:01:35 +02:00
parent 4785c9625c
commit 3e63602559
4 changed files with 24 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files
extension/shared/README.md
+14
View File
@@ -0,0 +1,14 @@
# ⚠️ READ BEFORE EDITING
This directory is a **MIRROR** of the root `/shared` folder.
**DO NOT edit these files directly.** Any changes made here will be overwritten the next time the synchronization script is run.
### Proper Workflow:
1. **Edit** the source files in the root `[repo_root]/shared/` directory.
2. **Run** the synchronization script:
- **Windows**: `[repo_root]\scripts\sync-constants.bat`
- **Linux/macOS**: `[repo_root]/scripts/sync-constants.sh`
3. **Verify** that the changes have propagated to this folder.
Failure to follow this protocol will result in out-of-sync components and broken protocol logic.