Food Desert commited on
Commit
468473c
·
1 Parent(s): 5cfd4a6

Add mandatory workspace bootstrap steps for Git alignment

Browse files

# Conflicts:
# PROJECT_SUMMARY.md
# SESSION_QUICKSTART.md

Files changed (1) hide show
  1. AGENTS.md +56 -20
AGENTS.md CHANGED
@@ -1,20 +1,56 @@
1
- # Codex Instructions (Prompt_Squirrel_RAG)
2
-
3
- ## Environment (Windows / PowerShell)
4
- - Always run from the repo root.
5
- - Never run `python` or `pip` directly.
6
- - Always use the venv interpreter:
7
- - `.venv\Scripts\python.exe`
8
- - Install deps with:
9
- - `.venv\Scripts\python.exe -m pip install -r requirements.txt`
10
-
11
- ## Change discipline
12
- - Keep diffs small: fix one issue or implement one focused step per patch.
13
- - Do not rewrite large files.
14
- - Do not move logic across modules unless the contract requires it.
15
- - Preserve stage boundaries: rewriting (LLM) vs retrieval (candidate generation) vs selection (index-only).
16
-
17
- ## Project contracts
18
- - Follow the retrieval grounding / candidate generation contract:
19
- - `docs/retrieval_contract.md`
20
- - If behavior conflicts with existing code, update code to match the contract (not the other way around).
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # Codex Instructions (Prompt_Squirrel_RAG)
2
+
3
+ ## Environment (Windows / PowerShell)
4
+ - Always run from the repo root.
5
+ - Never run `python` or `pip` directly.
6
+ - Always use the venv interpreter:
7
+ - `.venv\Scripts\python.exe`
8
+ - Install deps with:
9
+ - `.venv\Scripts\python.exe -m pip install -r requirements.txt`
10
+
11
+ ## Change discipline
12
+ - Keep diffs small: fix one issue or implement one focused step per patch.
13
+ - Do not rewrite large files.
14
+ - Do not move logic across modules unless the contract requires it.
15
+ - Preserve stage boundaries: rewriting (LLM) vs retrieval (candidate generation) vs selection (index-only).
16
+
17
+ ## Project contracts
18
+ - Follow the retrieval grounding / candidate generation contract:
19
+ - `docs/retrieval_contract.md`
20
+ - If behavior conflicts with existing code, update code to match the contract (not the other way around).
21
+
22
+ ## Git setup notes for this repository/user
23
+ - Default working branch on user machine:
24
+ - `claude/tag-generation-pipeline-raigF`
25
+ - This local branch should track GitHub remote branch:
26
+ - `github/claude/tag-generation-pipeline-raigF`
27
+ - Remote mapping currently used by user:
28
+ - `github` => `https://github.com/FoodDesert/Prompt_Squirrel_RAG.git`
29
+ - `origin` => `https://huggingface.co/spaces/FoodDesert/Prompt_Squirrel_RAG`
30
+ - For code collaboration, prefer explicit GitHub remote commands to avoid pushing code to Hugging Face remote.
31
+
32
+ ## Mandatory agent bootstrap for any new workspace
33
+ - Always run these first, in order:
34
+ 1. `git status --short --branch`
35
+ 2. `git remote -v`
36
+ 3. `git branch -vv`
37
+ 4. `rg --files | rg 'AGENTS.md|PROJECT_SUMMARY.md|SESSION_QUICKSTART.md'`
38
+ - If `github` remote is missing, add it immediately:
39
+ - `git remote add github https://github.com/FoodDesert/Prompt_Squirrel_RAG.git`
40
+ - If branch `claude/tag-generation-pipeline-raigF` is missing locally:
41
+ - `git fetch github`
42
+ - `git checkout -b claude/tag-generation-pipeline-raigF --track github/claude/tag-generation-pipeline-raigF`
43
+ - If branch exists but is not checked out:
44
+ - `git checkout claude/tag-generation-pipeline-raigF`
45
+ - Ensure upstream is GitHub branch:
46
+ - `git branch --set-upstream-to=github/claude/tag-generation-pipeline-raigF`
47
+ - Sync before any work:
48
+ - `git pull --rebase github claude/tag-generation-pipeline-raigF`
49
+
50
+ ### Git guidance style for this user
51
+ - Keep Git instructions short and step-by-step.
52
+ - Ask for / interpret `git status --short --branch` output first.
53
+ - Prefer explicit commands with remote names, e.g.:
54
+ - `git pull --rebase github claude/tag-generation-pipeline-raigF`
55
+ - `git push github HEAD`
56
+ - If branch divergence appears, prefer a low-risk resync path over complex conflict resolution.