Skip to content

Replace copy/paste instructions with simple reference examples for GitHub issue creation#36

Merged
DutchmanNL merged 4 commits intomainfrom
copilot/fix-35
Sep 19, 2025
Merged

Replace copy/paste instructions with simple reference examples for GitHub issue creation#36
DutchmanNL merged 4 commits intomainfrom
copilot/fix-35

Conversation

Copy link
Contributor

Copilot AI commented Sep 19, 2025

This PR eliminates the need for users to copy/paste large blocks of content when creating GitHub issues for template setup and updates. Instead, users now create issues with simple 2-3 line examples that reference template files, allowing GitHub Copilot agents to read requirements dynamically.

Problem

Previously, users were instructed to copy/paste complex markdown blocks (30+ lines) when creating GitHub issues:

**GitHub Copilot**: Please help me update my ioBroker Copilot instructions template to the latest version while preserving all custom sections.

## Task
Update `.github/copilot-instructions.md` using this prompt:

"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
[...continues for many more lines...]

This approach was prone to copy/paste errors, difficult on mobile devices, and required manual maintenance when requirements changed.

Solution

Users now create issues with simple references that let Copilot agents read template files dynamically:

New Repository Setup:

Title: 🤖 Setup ioBroker GitHub Copilot Instructions

GitHub Copilot: Please help me set up GitHub Copilot instructions for my ioBroker adapter repository using the template from:
templates/initial-setup-automation.md

Quick Updates:

Title: 🤖 Update ioBroker Copilot Instructions Template

GitHub Copilot: Please help me update my ioBroker Copilot instructions using the template from:
templates/copy-paste-template.md

Changes Made

  • README.md: Updated Quick Start section with simple issue creation examples
  • docs/setup.md: Replaced template usage instructions with concise issue examples
  • docs/automated-updates.md: Transformed "Copy-Paste Method" to "Simple Reference Method"
  • templates/README.md: Updated usage recommendations with streamlined examples
  • templates/copy-paste-template.md: Complete transformation from copy/paste template to dynamic reference guide
  • tests/: Updated test patterns to validate new approach

Benefits

  • 🎯 Eliminates copy/paste errors: No risk of users missing lines or malforming content
  • Faster issue creation: 2-3 lines instead of 30+ lines to copy/paste
  • 🤖 Dynamic content: Copilot agents read requirements directly from latest template files
  • 🛡️ Always up-to-date: References ensure users get current requirements without manual updates
  • 📱 Better mobile experience: No need to copy/paste large blocks on mobile devices

All existing functionality is preserved while significantly improving the user experience.

Fixes #35.


💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.

Copilot AI and others added 2 commits September 19, 2025 02:16
Co-authored-by: DutchmanNL <7318445+DutchmanNL@users.noreply.github.com>
Co-authored-by: DutchmanNL <7318445+DutchmanNL@users.noreply.github.com>
Copilot AI changed the title [WIP] avoid copy/paste of commands Replace copy/paste instructions with simple reference examples for GitHub issue creation Sep 19, 2025
Copilot AI requested a review from DutchmanNL September 19, 2025 02:19
@DutchmanNL DutchmanNL marked this pull request as ready for review September 19, 2025 02:21
Copilot AI review requested due to automatic review settings September 19, 2025 02:21
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR transforms the GitHub issue creation process from requiring users to copy/paste large blocks of content (30+ lines) to using simple 2-3 line references that allow GitHub Copilot agents to read template requirements dynamically. This eliminates copy/paste errors, improves mobile experience, and ensures users always get up-to-date requirements.

  • Replaced complex copy/paste instructions with simple issue creation examples across all documentation
  • Updated template files to provide dynamic references instead of static content blocks
  • Modified test patterns to validate the new reference-based approach

Reviewed Changes

Copilot reviewed 7 out of 7 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
README.md Updated Quick Start section with simple issue creation examples instead of template file references
docs/setup.md Replaced template usage instructions with concise issue examples for both setup and updates
docs/automated-updates.md Transformed "Copy-Paste Method" to "Simple Reference Method" with streamlined instructions
templates/README.md Updated usage recommendations with new simplified issue creation patterns
templates/copy-paste-template.md Complete transformation from copy/paste template to dynamic reference guide
config/metadata.json Minor formatting change to labels array structure
tests/test-automated-templates.sh Updated test pattern to validate new issue creation instructions

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@DutchmanNL DutchmanNL merged commit 3ca215d into main Sep 19, 2025
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

avoid copy/paste of commands

3 participants