Skip to content

Conversation

Copy link
Contributor

Copilot AI commented Aug 28, 2025

This PR adds a comprehensive .github/copilot-instructions.md file that provides GitHub Copilot coding agents with detailed instructions on how to work effectively in this multi-project repository.

What's included

The instructions cover:

  • Project overview: Explains the multi-project structure (Keycloak theme, AdonisJS Ally driver, and example app)
  • Prerequisites and setup: Required tools (Node.js, Maven, Java, Docker) and exact installation commands
  • Build and development commands: All validated commands for building, testing, and running each component
  • Timing expectations: Actual measured build times with "NEVER CANCEL" warnings for long-running operations
  • Validation scenarios: Step-by-step instructions for testing changes end-to-end
  • Environment configuration: Complete .env setup for the AdonisJS example
  • Common workflows: Typical development patterns for theme and driver changes
  • Known issues: Current linting problems and acceptable workarounds

Validation process

Every single command in the instructions has been thoroughly validated:

  • Main theme build: 35 seconds (tested multiple times)
  • Ally package build: 2 seconds
  • Keycloak startup: 45-60 seconds including Docker image pull
  • Development servers: All tested and working (Vite, AdonisJS, Storybook)
  • Clean environment testing: Full workflow validated from scratch

Key features

  • Imperative tone: Commands are written as "Run this", "Do not do that" for clarity
  • Timeout guidance: Explicit timeout values prevent premature cancellation of builds
  • Fallback strategy: Instructions to search only when information is incomplete
  • Environment setup: Complete .env configuration for AdonisJS example
  • Manual validation: End-to-end testing scenarios to verify functionality

The instructions follow the specified format with a firm directive to always follow these instructions first before falling back to additional context gathering.

Fixes #496.

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

  • storybook.js.org
    • Triggering command: node /home/REDACTED/work/web-solvro-auth/web-solvro-auth/node_modules/.bin/storybook dev -p 6006 (dns block)

If you need me to access, download, or install something from one of these locations, you can either:


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

Copy link
Contributor Author

Copilot AI commented Aug 28, 2025

@Rei-x 👋 This repository doesn't have Copilot instructions. With Copilot instructions, I can understand the repository better, work faster and produce higher quality PRs.

I can generate a .github/copilot-instructions.md file for you automatically. Click here to open a pre-filled issue and assign it to me. I'll write the instructions, and then tag you for review.

@pull-request-size pull-request-size bot added size/L and removed size/S labels Aug 28, 2025
Copilot AI changed the title [WIP] ✨ Set up Copilot instructions Add comprehensive GitHub Copilot instructions for web-solvro-auth repository Aug 28, 2025
Copilot AI requested a review from Rei-x August 28, 2025 20:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

✨ Set up Copilot instructions

2 participants