Context engineering intro
This commit is contained in:
40
.claude/commands/execute-prp.md
Normal file
40
.claude/commands/execute-prp.md
Normal file
@@ -0,0 +1,40 @@
|
||||
# Execute BASE PRP
|
||||
|
||||
Implement a feature using using the PRP file.
|
||||
|
||||
## PRP File: $ARGUMENTS
|
||||
|
||||
## Execution Process
|
||||
|
||||
1. **Load PRP**
|
||||
- Read the specified PRP file
|
||||
- Understand all context and requirements
|
||||
- Follow all instructions in the PRP and extend the research if needed
|
||||
- Ensure you have all needed context to implement the PRP fully
|
||||
- Do more web searches and codebase exploration as needed
|
||||
|
||||
2. **ULTRATHINK**
|
||||
- Think hard before you execute the plan. Create a comprehensive plan addressing all requirements.
|
||||
- Break down complex tasks into smaller, manageable steps using your todos tools.
|
||||
- Use the TodoWrite tool to create and track your implementation plan.
|
||||
- Identify implementation patterns from existing code to follow.
|
||||
|
||||
3. **Execute the plan**
|
||||
- Execute the PRP
|
||||
- Implement all the code
|
||||
|
||||
4. **Validate**
|
||||
- Run each validation command
|
||||
- Fix any failures
|
||||
- Re-run until all pass
|
||||
|
||||
5. **Complete**
|
||||
- Ensure all checklist items done
|
||||
- Run final validation suite
|
||||
- Report completion status
|
||||
- Read the PRP again to ensure you have implemented everything
|
||||
|
||||
6. **Reference the PRP**
|
||||
- You can always reference the PRP again if needed
|
||||
|
||||
Note: If validation fails, use error patterns in PRP to fix and retry.
|
||||
69
.claude/commands/generate-prp.md
Normal file
69
.claude/commands/generate-prp.md
Normal file
@@ -0,0 +1,69 @@
|
||||
# Create PRP
|
||||
|
||||
## Feature file: $ARGUMENTS
|
||||
|
||||
Generate a complete PRP for general feature implementation with thorough research. Ensure context is passed to the AI agent to enable self-validation and iterative refinement. Read the feature file first to understand what needs to be created, how the examples provided help, and any other considerations.
|
||||
|
||||
The AI agent only gets the context you are appending to the PRP and training data. Assuma the AI agent has access to the codebase and the same knowledge cutoff as you, so its important that your research findings are included or referenced in the PRP. The Agent has Websearch capabilities, so pass urls to documentation and examples.
|
||||
|
||||
## Research Process
|
||||
|
||||
1. **Codebase Analysis**
|
||||
- Search for similar features/patterns in the codebase
|
||||
- Identify files to reference in PRP
|
||||
- Note existing conventions to follow
|
||||
- Check test patterns for validation approach
|
||||
|
||||
2. **External Research**
|
||||
- Search for similar features/patterns online
|
||||
- Library documentation (include specific URLs)
|
||||
- Implementation examples (GitHub/StackOverflow/blogs)
|
||||
- Best practices and common pitfalls
|
||||
|
||||
3. **User Clarification** (if needed)
|
||||
- Specific patterns to mirror and where to find them?
|
||||
- Integration requirements and where to find them?
|
||||
|
||||
## PRP Generation
|
||||
|
||||
Using PRPs/templates/prp_base.md as template:
|
||||
|
||||
### Critical Context to Include and pass to the AI agent as part of the PRP
|
||||
- **Documentation**: URLs with specific sections
|
||||
- **Code Examples**: Real snippets from codebase
|
||||
- **Gotchas**: Library quirks, version issues
|
||||
- **Patterns**: Existing approaches to follow
|
||||
|
||||
### Implementation Blueprint
|
||||
- Start with pseudocode showing approach
|
||||
- Reference real files for patterns
|
||||
- Include error handling strategy
|
||||
- list tasks to be completed to fullfill the PRP in the order they should be completed
|
||||
|
||||
### Validation Gates (Must be Executable) eg for python
|
||||
```bash
|
||||
# Syntax/Style
|
||||
ruff check --fix && mypy .
|
||||
|
||||
# Unit Tests
|
||||
uv run pytest tests/ -v
|
||||
|
||||
```
|
||||
|
||||
*** CRITICAL AFTER YOU ARE DONE RESEARCHING AND EXPLORING THE CODEBASE BEFORE YOU START WRITING THE PRP ***
|
||||
|
||||
*** ULTRATHINK ABOUT THE PRP AND PLAN YOUR APPROACH THEN START WRITING THE PRP ***
|
||||
|
||||
## Output
|
||||
Save as: `PRPs/{feature-name}.md`
|
||||
|
||||
## Quality Checklist
|
||||
- [ ] All necessary context included
|
||||
- [ ] Validation gates are executable by AI
|
||||
- [ ] References existing patterns
|
||||
- [ ] Clear implementation path
|
||||
- [ ] Error handling documented
|
||||
|
||||
Score the PRP on a scale of 1-10 (confidence level to succeed in one-pass implementation using claude codes)
|
||||
|
||||
Remember: The goal is one-pass implementation success through comprehensive context.
|
||||
23
.claude/settings.local.json
Normal file
23
.claude/settings.local.json
Normal file
@@ -0,0 +1,23 @@
|
||||
{
|
||||
"permissions": {
|
||||
"allow": [
|
||||
"Bash(grep:*)",
|
||||
"Bash(ls:*)",
|
||||
"Bash(source:*)",
|
||||
"Bash(find:*)",
|
||||
"Bash(mv:*)",
|
||||
"Bash(mkdir:*)",
|
||||
"Bash(tree:*)",
|
||||
"Bash(ruff:*)",
|
||||
"Bash(touch:*)",
|
||||
"Bash(cat:*)",
|
||||
"Bash(ruff check:*)",
|
||||
"Bash(pytest:*)",
|
||||
"Bash(python:*)",
|
||||
"Bash(python -m pytest:*)",
|
||||
"Bash(python3 -m pytest:*)",
|
||||
"WebFetch(domain:docs.anthropic.com)"
|
||||
],
|
||||
"deny": []
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user