Skip to content

feat: add support for github split instructions #50

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

Open
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

DanielKlys7
Copy link

@DanielKlys7 DanielKlys7 commented May 12, 2025

Description

Add support for github split instructions:

Nagranie.z.ekranu.2025-05-12.o.03.29.56.mov

Fix bug regarding stale isMultiFileEnvironment after reload:

Nagranie.z.ekranu.2025-05-12.o.02.31.38.mov

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)

How Has This Been Tested?

Please describe the tests that you ran to verify your changes.

  • Unit Tests
  • E2E tests (in ci/cd)

Important Note for Fork-Based PRs

If you're submitting a PR from a forked repository, please note that E2E tests require specific repository-level environment (integration) and secrets to be set up. These are described in .env.example and include:

PUBLIC_ENV_NAME=integration
SUPABASE_URL=###
SUPABASE_PUBLIC_KEY=###

E2E_USERNAME_ID=###
E2E_USERNAME=###
E2E_PASSWORD=###

Please ensure these are properly configured in your fork's repository settings under "Secrets and variables" → "Actions" before running E2E tests.

adaptableFileEnvironments.has(selectedEnvironment) && isMultiFileEnvironment;

const extension =
AIEnvironmentName.GitHub && isMultiFileEnvironment ? 'instructions.md' : 'mdc';
Copy link
Author

Choose a reason for hiding this comment

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

Actually wondering whether it's a good solution or should we rather move it into some map for multiFileEnvironment paths for AIEnvironments

@psmyrdek
Copy link
Collaborator

psmyrdek commented May 15, 2025

Thanks for your effort @DanielKlys7! With regards to the change, I believe we should always prefer good defaults over selectors and checkboxes. So if we believe that multi-file instructions are now considered default in Copilot, we should move from this:

image

...into something like this:

image

Based on the documentation that you provided, we don't need to include config files. It is only required if you go against the convention of .github/instructions directory.

So:

  1. Make sure Copilot becomes multi-file environment
  2. The path to rules is updated per docs to match Copilot behavior

Once this is done and we can keep this simple, we'll be able to accept this PR.

(Another challenge is metadata - applyTo: '**' - but let's tackle it separately. I'll create dedicated issue for it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants