Skip to content

✨ Set up comprehensive Copilot instructions#223

Draft
Copilot wants to merge 2 commits into
mainfrom
copilot/fix-ca9c2eea-a3c1-4a42-aa71-f300d07322d0
Draft

✨ Set up comprehensive Copilot instructions#223
Copilot wants to merge 2 commits into
mainfrom
copilot/fix-ca9c2eea-a3c1-4a42-aa71-f300d07322d0

Conversation

Copy link
Copy Markdown

Copilot AI commented Sep 25, 2025

Configured comprehensive Copilot instructions for the Remarklet repository following GitHub's best practices for Copilot coding agents.

Overview

Enhanced the existing .github/copilot-instructions.md file from basic coding guidelines to a comprehensive development guide that provides AI assistants and contributors with detailed context about the project architecture, workflows, and conventions.

Key Improvements

Project Context

  • Added detailed project overview explaining Remarklet's purpose as a visual web page editing library
  • Documented key features including drag-and-drop, text editing, CSS manipulation, and touch support
  • Provided clear architecture description of the ES6 module library structure

Development Workflow

  • Complete setup instructions with Node.js version requirements
  • Comprehensive npm scripts documentation for build, test, and lint processes
  • Testing strategy covering both Playwright E2E tests and Node.js unit tests

Enhanced Coding Standards

  • JavaScript/TypeScript specific conventions with concrete examples
  • API design patterns for module structure and DOM interactions
  • Error handling and debugging guidelines with code examples
  • Performance considerations for DOM manipulation and memory management

Documentation & Contribution Guidelines

  • JSDoc standards with comprehensive examples
  • Browser compatibility requirements and testing approach
  • Troubleshooting section for common development issues
  • Clear contribution workflow references

Technical Details

The enhanced instructions now provide guidance for:

  • Module organization in the src/ directory with detailed component descriptions
  • Build process using Rollup bundling and TypeScript definition generation
  • Testing patterns for both E2E browser testing and unit testing
  • CSS management patterns and DOM interaction best practices

This follows the referenced best practices guide to help Copilot provide more accurate and context-aware assistance when working on the Remarklet codebase.

Original prompt

This section details on the original issue you should resolve

<issue_title>✨ Set up Copilot instructions</issue_title>
<issue_description>Configure instructions for this repository as documented in Best practices for Copilot coding agent in your repository.

</issue_description>

Comments on the Issue (you are @copilot in this section)

Fixes #222

💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

Co-authored-by: ZachWatkins <3458875+ZachWatkins@users.noreply.github.com>
Copilot AI changed the title [WIP] ✨ Set up Copilot instructions ✨ Set up comprehensive Copilot instructions Sep 25, 2025
Copilot AI requested a review from ZachWatkins September 25, 2025 12:18
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.

✨ Set up Copilot instructions

2 participants