-
Notifications
You must be signed in to change notification settings - Fork 11
Harden prompt-doc example link hygiene and codify placeholder-path policy #14
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
13 commits
Select commit
Hold shift + click to select a range
ae15cd7
update: refine claude agent system prompt for clearer APEI workflow
Copilot 308c336
docs: add concrete technology recommendation patterns
Copilot 0f53bd7
docs: apply final consistency fixes from prompt review
Copilot 251bf9f
docs: remove redundant heading in progress template
Copilot 07641d4
docs: restore explicit security and recommendation guidance
Copilot 92b5b2a
docs: normalize technology recommendation wording
Copilot 3dcae0a
docs: standardize field label formatting in specificity example
Copilot 1166801
docs: implement outcome-first active/archive prompt portfolio
Copilot f53460d
docs: address review feedback on clarity and quality gate examples
Copilot 4026735
docs: add llms.txt index and wire LLM navigation guidance
Copilot 3b636db
docs: harden markdownlint baseline and resolve repository lint errors
Copilot 28fc3c9
docs: fix broken internal example links in prompt library
Copilot a8c34ff
Improve prompt-doc link hygiene and codify example-path guidance
Copilot File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| { | ||
| "config": { | ||
| "MD010": { | ||
| "code_blocks": false | ||
| }, | ||
| "MD013": false, | ||
| "MD022": false, | ||
| "MD024": false, | ||
| "MD031": false, | ||
| "MD032": false, | ||
| "MD033": false, | ||
| "MD040": false, | ||
| "MD058": false, | ||
| "MD060": false | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,92 +1,63 @@ | ||
| # Contributing | ||
|
|
||
| ## Scope | ||
|
|
||
| This repository is **English-only** and **Markdown-only**. | ||
|
|
||
| ## How to Contribute | ||
|
|
||
| | Type | Description | | ||
| |------|-------------| | ||
| | **New Project Types** | Desktop apps, data engineering, etc. | | ||
| | **New Agent Types** | Specialized agent prompts with protocol acronyms | | ||
| | **New Examples** | Real-world walkthroughs demonstrating APEI cycle | | ||
| | **Improvements** | Better practices, clearer instructions, examples | | ||
| | **Bug Fixes** | Typos, broken links, formatting issues | | ||
|
|
||
| ## Quick Setup | ||
|
|
||
| ```bash | ||
| git clone https://github.com/Rtur2003/Claude-Code-Promts.git | ||
| cd Claude-Code-Promts | ||
| git checkout -b feature/your-feature-name | ||
| ``` | ||
|
|
||
| ## File Structure | ||
|
|
||
| ``` | ||
| prompts/ | ||
| └── english/ | ||
| ├── agents/ # Agent-optimized prompts (34 files) | ||
| ├── base/ # Foundation prompts | ||
| ├── project-types/ # Domain-specific prompts (11 files) | ||
| ├── examples/ # Usage examples (10 files) | ||
| └── workflows/ # Process guides (5 files) | ||
| ``` | ||
| | New prompts | Agent, project-type, or workflow prompts | | ||
| | Improvements | Better structure, clarity, outcome quality | | ||
| | Examples | Real-world APEI walkthroughs | | ||
| | Maintenance | Link fixes, catalog cleanup, archive actions | | ||
|
|
||
| ## Naming Convention | ||
| ## Prompt Quality Standard | ||
|
|
||
| | Type | Format | Example | | ||
| |------|--------|---------| | ||
| | Prompts | `kebab-case-prompt.md` | `code-review-prompt.md` | | ||
| | Guides | `kebab-case-guide.md` | `iterative-development-guide.md` | | ||
| | Index | `INDEX.md` | `INDEX.md` | | ||
| Every prompt must contain: | ||
| - `## Role` | ||
| - `## Protocol / Core Loop` | ||
| - `## Phases` | ||
| - `## Remember` (final section) | ||
|
|
||
| ## Prompt Template | ||
| ### No Vague Advice Rule | ||
|
|
||
| ```markdown | ||
| # Prompt Title | ||
| Every recommendation should end with a concrete: | ||
| - decision, or | ||
| - tool, or | ||
| - validation step. | ||
|
|
||
| > **Key Feature 1** | **Key Feature 2** | **Key Feature 3** | ||
| ## Archive Workflow | ||
|
|
||
| ## Role | ||
| [Define what this prompt does] | ||
| If a prompt is low-value or overlapping: | ||
| 1. Classify as keep / merge / archive | ||
| 2. Move to `prompts/english/agents/archive/` | ||
| 3. Update active indexes and README | ||
| 4. Add rationale to archive index | ||
|
|
||
| ## Protocol / Core Loop | ||
| [Main workflow] | ||
| ## Validation Before PR | ||
|
|
||
| ## Phases | ||
| [Phase details with templates and checklists] | ||
|
|
||
| ## Remember | ||
| [Key takeaways] | ||
| ``` | ||
|
|
||
| ## Checklist Before Submitting | ||
|
|
||
| - [ ] Content is accurate and follows best practices | ||
| - [ ] Markdown renders correctly | ||
| - [ ] No spelling or grammar errors | ||
| - [ ] INDEX files updated | ||
| - [ ] Links work correctly | ||
| - [ ] Follows existing style | ||
| - [ ] Internal relative links resolve | ||
| - [ ] Hypothetical example paths are plain code literals (not Markdown links) | ||
| - [ ] Catalog/index entries are updated | ||
| - [ ] `llms.txt` is updated when primary navigation or core prompts change | ||
| - [ ] No vague advice language | ||
|
|
||
| ## Commit Messages | ||
| Optional local checks: | ||
|
|
||
| ```bash | ||
| feat: add security audit prompt # New features | ||
| fix: correct typo in API prompt # Fixes | ||
| docs: improve README examples # Documentation | ||
| update: enhance code review checklist # Updates | ||
| grep -r '\[.*\](.*\.md)' prompts/ | head | ||
| npx markdownlint-cli2 '**/*.md' | ||
| ``` | ||
|
|
||
| ## Pull Request Process | ||
|
|
||
| 1. Create branch → make changes → commit | ||
| 2. Push and create PR with clear description | ||
| 3. Address review feedback | ||
| 4. Merge after approval | ||
| ## Commit Message Style | ||
|
|
||
| ## License | ||
|
|
||
| Contributions are licensed under MIT License. | ||
|
|
||
| --- | ||
|
|
||
| Thank you for contributing! 🚀 | ||
| ```text | ||
| feat: add new prompt | ||
| fix: correct catalog link | ||
| docs: improve usage guidance | ||
| update: archive overlapping prompt | ||
| ``` |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,116 +1,44 @@ | ||
| # Quick Start | ||
|
|
||
| ## 1. Pick Your Prompt | ||
| ## 1) Start Minimal | ||
|
|
||
| ### AI Agents (Claude Code, Copilot, etc.) | ||
| | Situation | Prompt Setup | | ||
| |-----------|--------------| | ||
| | Any autonomous coding task | **Agent System** ⭐ | | ||
| | Tight token budget | **Quick Reference** | | ||
| | Claude Code setup | Agent System + **Claude Code Workflow** | | ||
| | Production debugging | Agent System + **Debugging & Troubleshooting** | | ||
| | Security-sensitive task | Agent System + **Security Audit** | | ||
|
|
||
| | Task | Prompt | File | | ||
| |------|--------|------| | ||
| | Any autonomous task | **Agent System** ⭐ | [View](prompts/english/agents/claude-agent-system-prompt.md) | | ||
| | Debugging | Agent System + **Error Analysis** | [View](prompts/english/agents/error-analysis-prompt.md) | | ||
| | New/existing project | Agent System + **Project Workflow** | [View](prompts/english/agents/project-workflow-prompt.md) | | ||
| | PR review | Agent System + **Code Review** | [View](prompts/english/agents/code-review-prompt.md) | | ||
| | Security check | Agent System + **Security Audit** | [View](prompts/english/agents/security-audit-prompt.md) | | ||
| | Code improvement | Agent System + **Refactoring** | [View](prompts/english/agents/refactoring-prompt.md) | | ||
| | Test design | Agent System + **Testing** | [View](prompts/english/agents/testing-strategies-prompt.md) | | ||
| | Technical writing | Agent System + **Documentation** | [View](prompts/english/agents/documentation-prompt.md) | | ||
| | Optimize performance | Agent System + **Performance** | [View](prompts/english/agents/performance-optimization-prompt.md) | | ||
| | Git workflow | Agent System + **Git & VCS** | [View](prompts/english/agents/git-version-control-prompt.md) | | ||
| | System integrity | Agent System + **Integration Guardian** | [View](prompts/english/agents/integration-guardian-prompt.md) | | ||
| | Accessibility check | Agent System + **Accessibility Audit** | [View](prompts/english/agents/accessibility-audit-prompt.md) | | ||
| | Migration/upgrade | Agent System + **Migration & Upgrade** | [View](prompts/english/agents/migration-upgrade-prompt.md) | | ||
| | Set up monitoring | Agent System + **Monitoring & Observability** | [View](prompts/english/agents/monitoring-observability-prompt.md) | | ||
| | Production debugging | Agent System + **Debugging & Troubleshooting** | [View](prompts/english/agents/debugging-troubleshooting-prompt.md) | | ||
| | Minimal context | **Quick Reference** only | [View](prompts/english/agents/agent-quick-reference.md) | | ||
| ## 2) Add One Specialist Only If Needed | ||
|
|
||
| ### Claude Code-Specific | ||
| Need criteria: add a specialist only when Agent System alone cannot provide domain-specific protocols for your task. | ||
|
|
||
| | Task | Prompt | File | | ||
| |------|--------|------| | ||
| | Mode planning (/think, /ultrathink) | **Claude Code Modes** ⭐ | [View](prompts/english/agents/claude-code-modes-prompt.md) | | ||
| | Token efficiency | **Claude Code Tokens** | [View](prompts/english/agents/claude-code-token-optimization-prompt.md) | | ||
| | CLAUDE.md & hooks setup | **Claude Code Workflow** | [View](prompts/english/agents/claude-code-workflow-prompt.md) | | ||
| | Need | Add | | ||
| |------|-----| | ||
| | Architecture decisions | Architecture Patterns | | ||
| | Tool/library selection | Technology Stack | | ||
| | Multi-agent parallel flow | Multi-Agent Orchestration | | ||
| | Performance bottlenecks | Performance Optimization | | ||
| | Reliability hardening | Error Handling & Resilience | | ||
|
|
||
| ### Architecture & Development | ||
| ## 3) Use APEI Loop | ||
|
|
||
| | Task | Prompt | File | | ||
| |------|--------|------| | ||
| | Tool/library selection | **Technology Stack** ⭐ | [View](prompts/english/agents/technology-stack-prompt.md) | | ||
| | System design & patterns | **Architecture Patterns** | [View](prompts/english/agents/architecture-patterns-prompt.md) | | ||
| | Modern full-stack app | **Full-Stack Development** | [View](prompts/english/agents/fullstack-development-prompt.md) | | ||
| | Complex multi-step tasks | **Prompt Chaining** | [View](prompts/english/agents/prompt-chaining-prompt.md) | | ||
| | Add AI/LLM features | **AI & LLM Integration** | [View](prompts/english/agents/ai-llm-integration-prompt.md) | | ||
| | API design / GraphQL | **API Design & GraphQL** | [View](prompts/english/agents/api-design-graphql-prompt.md) | | ||
| | Cloud deployment | **Cloud & Infrastructure** | [View](prompts/english/agents/cloud-infrastructure-prompt.md) | | ||
| | Data pipelines | **Data Engineering** | [View](prompts/english/agents/data-engineering-prompt.md) | | ||
| | Compliance audit | **Compliance & Governance** | [View](prompts/english/agents/compliance-governance-prompt.md) | | ||
| | Multi-agent coordination | **Multi-Agent Orchestration** | [View](prompts/english/agents/multi-agent-orchestration-prompt.md) | | ||
| | Monorepo / complex project | **Monorepo & Complex Projects** | [View](prompts/english/agents/monorepo-complex-projects-prompt.md) | | ||
| | Error handling / resilience | **Error Handling & Resilience** | [View](prompts/english/agents/error-handling-resilience-prompt.md) | | ||
| | Developer experience / tooling | **Developer Experience & Tooling** | [View](prompts/english/agents/developer-experience-tooling-prompt.md) | | ||
| | Database design / optimization | **Database Design & Optimization** | [View](prompts/english/agents/database-optimization-prompt.md) | | ||
| | UI components / design system | **UI/UX & Design Systems** | [View](prompts/english/agents/ui-design-systems-prompt.md) | | ||
|
|
||
| ### Interactive Sessions | ||
|
|
||
| | Project | Prompts | Files | | ||
| |---------|---------|-------| | ||
| | Any project | **Foundation** ⭐ | [View](prompts/english/base/claude-foundation-prompt.md) | | ||
| | React / Vue app | Foundation + **Web Dev** | [View](prompts/english/project-types/web-development-prompt.md) | | ||
| | REST / GraphQL API | Foundation + **API Dev** | [View](prompts/english/project-types/api-development-prompt.md) | | ||
| | ML / Data Science | Foundation + **Data Science** | [View](prompts/english/project-types/data-science-ml-prompt.md) | | ||
| | iOS / Android app | Foundation + **Mobile** | [View](prompts/english/project-types/mobile-development-prompt.md) | | ||
| | DevOps / Infra | Foundation + **DevOps** | [View](prompts/english/project-types/devops-cicd-prompt.md) | | ||
| | Database design | Foundation + **Database** | [View](prompts/english/project-types/database-sql-prompt.md) | | ||
| | General software | Foundation + **General Software** | [View](prompts/english/project-types/general-software-development-prompt.md) | | ||
| | Game development | Foundation + **Game Dev** | [View](prompts/english/project-types/game-development-prompt.md) | | ||
| | Embedded / IoT | Foundation + **Embedded & IoT** | [View](prompts/english/project-types/embedded-iot-prompt.md) | | ||
| | Smart contracts | Foundation + **Blockchain & Web3** | [View](prompts/english/project-types/blockchain-web3-prompt.md) | | ||
| | Desktop app | Foundation + **Desktop Apps** | [View](prompts/english/project-types/desktop-development-prompt.md) | | ||
| | Full-stack app | Foundation + Web + API | — | | ||
|
|
||
| --- | ||
|
|
||
| ## 2. Copy & Paste | ||
|
|
||
| **Agent mode:** Copy the prompt file content → paste as system prompt → give your task. | ||
|
|
||
| **Interactive mode:** Copy Foundation + project prompt → paste at session start → describe your task. | ||
|
|
||
| --- | ||
|
|
||
| ## 3. Core Method (APEI) | ||
|
|
||
| ``` | ||
| ```text | ||
| ANALYZE → PLAN → EXECUTE → ITERATE | ||
| ↑ │ | ||
| └── Not optimal? ──────────┘ | ||
| ``` | ||
|
|
||
| All prompts follow this cycle automatically. | ||
|
|
||
| --- | ||
|
|
||
| ## Token Budget | ||
| ## 4) Token Budget | ||
|
|
||
| | Budget | Setup | | ||
| |--------|-------| | ||
| | < 2K | Quick Reference only | | ||
| | 2K–8K | Agent System Prompt | | ||
| | 8K+ | Agent System + project-type prompt | | ||
|
|
||
| --- | ||
| | 2K–8K | Agent System | | ||
| | 8K+ | Agent System + 1 specialist | | ||
|
|
||
| ## Documentation | ||
| ## 5) Catalogs | ||
|
|
||
| - [README.md](README.md) — Full catalog & overview | ||
| - [USAGE.md](USAGE.md) — Detailed examples | ||
| - [CHANGELOG.md](CHANGELOG.md) — Version history | ||
| - [CLAUDE.md](CLAUDE.md) — AI agent configuration for this repo | ||
| - [Agent Index](prompts/english/agents/INDEX.md) — All agent prompts | ||
| - [Prompt Index](prompts/english/INDEX.md) — All prompts by category | ||
| - [Prompt Selector](prompts/english/workflows/prompt-selector-guide.md) — Decision tree for choosing prompts | ||
| - [Workflow Guide](prompts/english/workflows/iterative-development-guide.md) — APEI deep-dive | ||
| - [Troubleshooting Guide](prompts/english/workflows/troubleshooting-guide.md) — Issue diagnosis flowchart | ||
| - [Claude Code Setup Guide](prompts/english/workflows/claude-code-setup-guide.md) — `.claude/` directory, CLAUDE.md hierarchy, prompt placement | ||
| - [Best Practices Guide](prompts/english/workflows/best-practices-customization-guide.md) — Prompt customization & team standards | ||
| - [Active Agent Index](prompts/english/agents/INDEX.md) | ||
| - [Archived Prompt Index](prompts/english/agents/archive/INDEX.md) | ||
| - [Global Prompt Index](prompts/english/INDEX.md) | ||
| - [LLM Index](llms.txt) |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
## [Unreleased]now contains two separate### Addedsections (lines 9 and 31). This breaks the usual Keep a Changelog structure and makes it unclear which items belong together; consider merging the later### Addedentries into the first### Addedblock (and likewise ensure each subsection appears only once per release).