-
Notifications
You must be signed in to change notification settings - Fork 2
Replace copy/paste instructions with simple reference examples for GitHub issue creation #36
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 3 commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
6fb6659
Initial plan
Copilot 7b1d901
Replace copy/paste instructions with simple reference examples
Copilot c31fb65
Final verification: copy/paste elimination completed successfully
Copilot 97d683b
Update templates/copy-paste-template.md
DutchmanNL 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
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
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,47 +1,51 @@ | ||
| # Quick Copy-Paste Template for Template Updates | ||
| # Quick Template Update Guide | ||
|
|
||
| Copy and paste this content when creating a new issue in your ioBroker adapter repository to automatically update your Copilot instructions template: | ||
| This guide shows you how to create a simple GitHub issue that will automatically update your Copilot instructions template. No copy/paste required - just reference this file and let GitHub Copilot read the requirements dynamically. | ||
|
|
||
| --- | ||
| ## Simple Issue Creation | ||
|
|
||
| ### Title: | ||
| ``` | ||
| 🤖 Update ioBroker Copilot Instructions Template | ||
| ``` | ||
|
|
||
| ## Title: 🤖 Update ioBroker Copilot Instructions Template | ||
| ### Issue Content: | ||
| ``` | ||
| GitHub Copilot: Please help me update my ioBroker Copilot instructions template to the latest version while preserving all custom sections. | ||
|
|
||
| ## Issue Content: | ||
| Please use the requirements from: templates/copy-paste-template.md | ||
| ``` | ||
|
|
||
| ## Template Update Requirements | ||
|
|
||
| ```markdown | ||
| **Prerequisites**: Ensure GitHub Copilot is active in your repository. If not set up yet, create an issue first: "🤖 Setup GitHub Copilot" with content "GitHub Copilot: Please help me set up GitHub Copilot for this repository." | ||
|
|
||
| **GitHub Copilot**: Please help me update my ioBroker Copilot instructions template to the latest version while preserving all custom sections. | ||
| ### Update Requirements for GitHub Copilot: | ||
|
|
||
| ## Task | ||
| Update `.github/copilot-instructions.md` using this prompt: | ||
| When GitHub Copilot processes the update request, it should: | ||
|
|
||
| ``` | ||
| "Merge the ioBroker template from https://github.com/DrozmotiX/ioBroker-Copilot-Instructions/blob/main/template.md with my existing .github/copilot-instructions.md. | ||
|
|
||
| REQUIREMENTS: | ||
| 1. Preserve ALL [CUSTOMIZE] sections exactly as they are | ||
| 2. Keep all project-specific context not already covered in the standard template | ||
| 3. Add latest ioBroker best practices from the new template | ||
| 4. Update version to match latest template version | ||
| 5. Maintain Template Source reference | ||
| 6. REMOVE any duplicate content from [CUSTOMIZE] sections that already exists in the standard template | ||
| 7. Keep only truly unique, adapter-specific content in [CUSTOMIZE] sections | ||
|
|
||
| Show me the changes before applying them." | ||
| ``` | ||
| 1. **Merge the latest template**: Fetch from https://github.com/DrozmotiX/ioBroker-Copilot-Instructions/blob/main/template.md | ||
| 2. **Preserve ALL [CUSTOMIZE] sections exactly as they are** | ||
| 3. **Keep all project-specific context** not already covered in the standard template | ||
| 4. **Add latest ioBroker best practices** from the new template | ||
| 5. **Update version** to match latest template version | ||
| 6. **Maintain Template Source reference** | ||
| 7. **REMOVE duplicate content** from [CUSTOMIZE] sections that already exists in the standard template | ||
| 8. **Keep only truly unique, adapter-specific content** in [CUSTOMIZE] sections | ||
| 9. **Show changes before applying them** | ||
|
|
||
| ## Validation | ||
| After update, confirm: | ||
| ## Validation Checklist | ||
|
|
||
| After the update, confirm: | ||
| - [ ] All [CUSTOMIZE] sections preserved | ||
| - [ ] Version updated to latest | ||
| - [ ] Custom content intact | ||
| - [ ] Custom content intact | ||
| - [ ] Template structure complete | ||
| - [ ] No duplicate content between [CUSTOMIZE] sections and standard template | ||
|
|
||
| **Reference**: https://github.com/DrozmotiX/ioBroker-Copilot-Instructions | ||
| ``` | ||
| ## Reference | ||
| **Template Repository**: https://github.com/DrozmotiX/ioBroker-Copilot-Instructions | ||
|
|
||
| --- | ||
|
|
||
| **Instructions**: Copy the content above (including the markdown code blocks) and paste it when creating a new issue in your repository. GitHub Copilot will automatically process this and help you update your template. | ||
| **Instructions for Users**: Create a GitHub issue with the title and content shown above. GitHub Copilot will automatically read this file and apply all the requirements without you needing to copy/paste anything. | ||
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
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.
Uh oh!
There was an error while loading. Please reload this page.