Update STARTER-PROMPT.md with AI IDE context recommendations and add to wiki
Some checks failed
Tests / PHP 7.0 (push) Has been cancelled
Tests / PHP 7.4 (push) Has been cancelled
Tests / PHP 8.0 (push) Has been cancelled
Tests / Code Style (push) Has been cancelled
Release / Build and Release (push) Has been cancelled
Sync Wiki / Sync Wiki to GitHub (push) Has been cancelled
Some checks failed
Tests / PHP 7.0 (push) Has been cancelled
Tests / PHP 7.4 (push) Has been cancelled
Tests / PHP 8.0 (push) Has been cancelled
Tests / Code Style (push) Has been cancelled
Release / Build and Release (push) Has been cancelled
Sync Wiki / Sync Wiki to GitHub (push) Has been cancelled
This commit is contained in:
@ -2,6 +2,10 @@
|
||||
|
||||
This document provides a comprehensive prompt to help you get started with creating your own WordPress plugin using this starter template with the assistance of AI tools like GitHub Copilot, Claude, or ChatGPT.
|
||||
|
||||
## Important: Optimize AI Context
|
||||
|
||||
**Before starting, add the .ai-assistant.md file and .ai-workflows/ directory to your AI IDE chat context.** In most AI IDEs, you can pin these files to ensure they're considered in each message. This will help the AI understand the project structure and follow the established best practices.
|
||||
|
||||
## Initial Setup Prompt
|
||||
|
||||
Use the following prompt to guide the AI assistant in helping you set up your new plugin based on this template:
|
||||
@ -31,6 +35,8 @@ I need help with the following tasks:
|
||||
2. Customizing the plugin structure for my specific needs
|
||||
3. Setting up the initial functionality for my plugin
|
||||
|
||||
I've added the .ai-assistant.md and .ai-workflows/ directory to the chat context to ensure you have all the necessary information about the project structure and best practices.
|
||||
|
||||
Please guide me through this process step by step, starting with identifying all files that need to be updated with my plugin information.
|
||||
```
|
||||
|
||||
@ -163,12 +169,21 @@ Please guide me through the process of building and testing my plugin:
|
||||
4. What should I check before releasing the first version?
|
||||
```
|
||||
|
||||
## Optimizing AI Assistance
|
||||
|
||||
To ensure the AI assistant has all the necessary context about your plugin's structure and best practices:
|
||||
|
||||
```
|
||||
Please add the .ai-assistant.md and .ai-workflows/ directory to your AI IDE chat context. In most AI IDEs, you can pin these files to ensure they're considered in each message. This will help the AI understand the project structure and follow the established best practices.
|
||||
```
|
||||
|
||||
## Remember
|
||||
|
||||
- This template is designed to be a starting point. Feel free to add, remove, or modify components as needed for your specific plugin.
|
||||
- The AI assistant can help you understand the existing code and make appropriate modifications, but you should review all changes to ensure they meet your requirements.
|
||||
- Always test your plugin thoroughly before releasing it.
|
||||
- Keep documentation updated as you develop your plugin.
|
||||
- Pin the .ai-assistant.md and .ai-workflows/ files in your AI IDE chat to ensure the AI has the necessary context for each interaction.
|
||||
|
||||
## Credits
|
||||
|
||||
|
Reference in New Issue
Block a user