Skip to content

Commit be55df3

Browse files
update README-RALPH-prompt-writing rule
1 parent 03cf309 commit be55df3

1 file changed

Lines changed: 30 additions & 0 deletions

File tree

.ai/rules/ralph/README-RALPH-prompt-writing.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -160,6 +160,12 @@ If stuck after 15 iterations:
160160
Provide clear technical context:
161161

162162
```markdown
163+
## Project Setup
164+
165+
- **Project Root Directory**: [path]
166+
- **Python Executable**: [command, e.g., `uv run python`]
167+
- **Files & Folders Ralph Can Modify**: [explicit list]
168+
163169
## Context
164170

165171
- Use Express.js for the API
@@ -177,6 +183,7 @@ Provide clear technical context:
177183
```
178184

179185
**Key Points:**
186+
- **Always include Project Setup section** with project root, Python executable, and allowed files/folders
180187
- Specify technology stack
181188
- Document existing patterns to follow
182189
- List hard constraints
@@ -258,6 +265,29 @@ Here's a comprehensive template:
258265

259266
[2-3 sentence description of what needs to be built/fixed/improved]
260267

268+
## Project Setup
269+
270+
**MANDATORY**: Specify these basics for every README-RALPH.md:
271+
272+
- **Project Root Directory**: [Absolute or relative path to project root]
273+
- All commands must be run from this directory
274+
- Example: `Dana projects/Honeywell/Forge-Cognition`
275+
276+
- **Python Executable**: [How to run Python scripts]
277+
- Specify the exact command to use (e.g., `uv run python`, `python`, `python3`)
278+
- Specify that commands must be run from project root
279+
- Example: `uv run python` (run from project root directory)
280+
281+
- **Files & Folders Ralph Can Modify**: [Explicit list of what Ralph is allowed to change]
282+
- List specific files that can be modified
283+
- List directories where Ralph can create/write files (e.g., exercise directory)
284+
- Be explicit about what's allowed vs. what's off-limits
285+
- Example:
286+
- `_RALPH/` directory (Ralph exercise directory - can write whatever it wants)
287+
- `_RALPH/[exercise-name]/` (specific exercise directory)
288+
- `autonomous_facility/ontology/physical/models.py` (specific file to modify)
289+
- `autonomous_facility/ontology/physical/schema/models.py` (specific file to modify)
290+
261291
## Requirements
262292

263293
### Functional Requirements

0 commit comments

Comments
 (0)