Skip to content

Create comprehensive GitHub Copilot instructions with validated commands and timing - #1033

Closed
maiertech with Copilot wants to merge 3 commits into
mainfrom
copilot/fix-1032
Closed

Create comprehensive GitHub Copilot instructions with validated commands and timing#1033
maiertech with Copilot wants to merge 3 commits into
mainfrom
copilot/fix-1032

Conversation

Copilot AI commented Sep 21, 2025

Copy link
Copy Markdown
Contributor

This PR creates a comprehensive .github/copilot-instructions.md file that provides GitHub Copilot coding agents with complete guidance for working in this SvelteKit codebase.

Key Features

Authentication Requirements: Documents the critical requirement for a GitHub Personal Access Token with repo and read:packages permissions to access the private @maiertech/sveltekit-helpers package.

Validated Command Timing: All commands have been tested and timed with specific timeout recommendations:

  • Installation: ~25 seconds (22s measured)
  • Format: ~4 seconds
  • Lint: ~4 seconds
  • Format + Lint chain: ~15 seconds
  • Type checking: ~8 seconds
  • Build: 15-30 seconds (with proper dependencies)

NEVER CANCEL Warnings: Explicit warnings throughout the instructions to prevent premature cancellation of long-running commands, with specific timeout values for each operation.

Complete Development Workflow: Covers the entire development process from initial setup through validation:

  • Environment variable configuration
  • Dependency installation with authentication
  • Development server operation
  • Build and deployment process
  • Pre-commit validation steps

Troubleshooting Section: Comprehensive guidance for common issues including authentication failures, missing dependencies, and build problems.

Manual Validation Scenarios: Specific user scenarios for testing functionality after making changes, including navigation to key pages and browser console verification.

Technical Documentation

The instructions document the complete tech stack (SvelteKit v2, Svelte v5, TypeScript, TailwindCSS v4, Mdsvex), repository structure, code style guidelines, and common development patterns specific to this personal website codebase.

The file starts with a firm directive to follow these instructions first before falling back to additional search or context gathering, ensuring agents have reliable, tested guidance for working effectively in this repository.

Fixes #1032.


✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

@vercel

vercel Bot commented Sep 21, 2025

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Preview Updated (UTC)
website Error Error Sep 21, 2025 6:53pm

…and timing

Co-authored-by: maiertech <1482402+maiertech@users.noreply.github.com>
Co-authored-by: maiertech <1482402+maiertech@users.noreply.github.com>
Copilot AI changed the title [WIP] ✨ Set up Copilot instructions Create comprehensive GitHub Copilot instructions with validated commands and timing Sep 21, 2025
Copilot AI requested a review from maiertech September 21, 2025 18:53
@maiertech

Copy link
Copy Markdown
Owner

Obsolete with #1027.

@maiertech maiertech closed this Oct 4, 2025
@maiertech
maiertech deleted the copilot/fix-1032 branch October 4, 2025 22:19
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