Add prompting frameworks guide and expand prompt documentation#1073
Add prompting frameworks guide and expand prompt documentation#1073Krosebrook wants to merge 401 commits intof:mainfrom
Conversation
Co-authored-by: thanos0000@gmail.com <thanos0000@gmail.com@users.noreply.github.com>
Includes comprehensive documentation for RTF, RISEN, CO-STAR, CRISPE, APE, RACE, ROSES, RASCEF, Chain of Thought, TAG, BAB, CARE, SCAMPER, TRACE, and ERA frameworks. Each framework has a template and 3 practical examples covering various use cases.
📝 WalkthroughWalkthroughA new comprehensive documentation file cataloging 15 prompt-engineering frameworks is introduced, featuring standardized templates, detailed examples, selection guidelines, and tips. The README is updated with a reference link to this new guide. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
📝 Coding Plan
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Pull request overview
This PR adds a new PROMPTING-FRAMEWORKS.md file documenting 15 prompt engineering frameworks with templates and examples, and adds a link to it from the README.
Changes:
- New
PROMPTING-FRAMEWORKS.mdwith 15 prompting frameworks (RTF, RISEN, CO-STAR, CRISPE, APE, RACE, ROSES, RASCEF, Chain of Thought, TAG, BAB, CARE, SCAMPER, TRACE, ERA), each with a template and 3 practical examples, plus a selection guide and tips - Updated
README.mdwith a link to the new frameworks guide
Reviewed changes
Copilot reviewed 2 out of 4 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| README.md | Added a link to the new PROMPTING-FRAMEWORKS.md guide |
| PROMPTING-FRAMEWORKS.md | New comprehensive guide covering 15 prompting frameworks with templates, examples, and a selection guide |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
You can also share your feedback on Copilot code review. Take the survey.
| ```json | ||
| POST /api/v1/users | ||
| { | ||
| "email": "user@example.com", | ||
| "password": "securePassword123" | ||
| } | ||
| ``` |
| ```yaml | ||
| name: CI/CD Pipeline | ||
| on: | ||
| push: | ||
| branches: [main, develop] | ||
| ``` |
| ## Table of Contents | ||
|
|
||
| 1. [RTF (Role-Task-Format)](#1-rtf-role-task-format) | ||
| 2. [RISEN (Role-Instruction-Structure-Examples-Nuance)](#2-risen-role-instruction-structure-examples-nuance) | ||
| 3. [CO-STAR (Context-Objective-Style-Tone-Audience-Response)](#3-co-star-context-objective-style-tone-audience-response) | ||
| 4. [CRISPE (Capacity-Role-Insight-Statement-Personality-Experiment)](#4-crispe-capacity-role-insight-statement-personality-experiment) | ||
| 5. [APE (Action-Purpose-Expectation)](#5-ape-action-purpose-expectation) | ||
| 6. [RACE (Role-Action-Context-Expectations)](#6-race-role-action-context-expectations) | ||
| 7. [ROSES (Role-Objective-Scenario-Expected Solution-Steps)](#7-roses-role-objective-scenario-expected-solution-steps) | ||
| 8. [RASCEF (Role-Action-Steps-Context-Examples-Format)](#8-rascef-role-action-steps-context-examples-format) | ||
| 9. [Chain of Thought (CoT)](#9-chain-of-thought-cot) | ||
| 10. [TAG (Task-Action-Goal)](#10-tag-task-action-goal) | ||
| 11. [BAB (Before-After-Bridge)](#11-bab-before-after-bridge) | ||
| 12. [CARE (Context-Action-Result-Example)](#12-care-context-action-result-example) | ||
| 13. [SCAMPER (Substitute-Combine-Adapt-Modify-Put to other uses-Eliminate-Reverse)](#13-scamper-substitute-combine-adapt-modify-put-to-other-uses-eliminate-reverse) | ||
| 14. [TRACE (Task-Request-Action-Context-Example)](#14-trace-task-request-action-context-example) | ||
| 15. [ERA (Expectation-Role-Action)](#15-era-expectation-role-action) | ||
|
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
🧹 Nitpick comments (1)
PROMPTING-FRAMEWORKS.md (1)
35-1212: Consider adding language specifiers to fenced code blocks.The framework templates in code blocks currently lack language specifiers, which triggers markdown linting warnings. While these blocks contain prompt templates rather than programming code, adding a language identifier would improve markdown compliance and accessibility.
Consider adding
textormarkdownas the language identifier:```text **Role:** [Who should the AI act as] **Task:** [What you want the AI to do] **Format:** [How the output should be structured] ```This applies to template blocks throughout the document (69 instances flagged by markdownlint).
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@PROMPTING-FRAMEWORKS.md` around lines 35 - 1212, The fenced template code blocks (those starting with ``` and containing lines like "**Role:**", "**Task:**", "**Format:**" and the RISEN/CO-STAR/etc. examples) lack language specifiers and trigger markdownlint; update each template code block (all instances of the triple-backtick blocks that contain the prompt templates) to use a language identifier such as ```text or ```markdown so linting passes and accessibility improves; ensure you update every occurrence (~69 instances flagged) consistently across the document while preserving the exact block content.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Nitpick comments:
In `@PROMPTING-FRAMEWORKS.md`:
- Around line 35-1212: The fenced template code blocks (those starting with ```
and containing lines like "**Role:**", "**Task:**", "**Format:**" and the
RISEN/CO-STAR/etc. examples) lack language specifiers and trigger markdownlint;
update each template code block (all instances of the triple-backtick blocks
that contain the prompt templates) to use a language identifier such as ```text
or ```markdown so linting passes and accessibility improves; ensure you update
every occurrence (~69 instances flagged) consistently across the document while
preserving the exact block content.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: b5a49115-00da-4aa8-8809-fb23ff251095
⛔ Files ignored due to path filters (1)
prompts.csvis excluded by!**/*.csv
📒 Files selected for processing (3)
PROMPTING-FRAMEWORKS.mdPROMPTS.mdREADME.md
|
@copilot open a new pull request to apply changes based on the comments in this thread |
Description
This PR adds comprehensive documentation for prompt engineering frameworks and expands the existing prompt collection:
PROMPTING-FRAMEWORKS.md- A detailed guide covering 15 popular prompting frameworks (RTF, RISEN, CO-STAR, CRISPE, APE, RACE, ROSES, RASCEF, Chain of Thought, TAG, SPADE, SCAMPER, CLEAR, AIDA, and PREP) with templates and practical examples for eachPROMPTS.md- Significantly expanded with additional prompt content and examplesprompts.csv- Extended prompt collection with new entriesREADME.md- Added references to the new frameworks guideType of Change
Please don't edit
prompts.csvdirectly!Instead, visit prompts.chat and:
This ensures proper attribution, formatting, and keeps the repository in sync. You'll also appear on the Contributors page!
Additional Notes
The new
PROMPTING-FRAMEWORKS.mdfile provides a valuable resource for users looking to improve their prompt engineering skills with well-documented, battle-tested frameworks and real-world examples.https://claude.ai/code/session_015H9AvSBVn9EtEPV9Ccz72u
Summary by CodeRabbit