Skip to content

Add comprehensive GitHub Copilot instructions for repository development #2814

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.

Sign up for GitHub

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

Jump to bottom
Merged
VividLemon merged 4 commits into from
Aug 19, 2025
Merged

Add comprehensive GitHub Copilot instructions for repository development #2814

VividLemon merged 4 commits into from
Aug 19, 2025

Conversation

Copy link
Contributor

Copilot AI commented Aug 19, 2025 •
edited
Loading

This PR adds a comprehensive .github/copilot-instructions.md file that provides detailed guidance for GitHub Copilot coding agents working in the BootstrapVueNext repository.

What's Included

The instructions cover all essential development workflows:

Setup & Build Commands

  • Complete setup process using pnpm (the only allowed package manager)
  • Build commands for all packages with measured timing:
    • Core package: ~35 seconds
    • Playground app: ~8 seconds
    • Nuxt package: ~25 seconds
  • Development server setup for each component

Validation & Testing

  • Unit testing workflow (40 seconds, 1567+ tests)
  • Linting process (12 seconds)
  • Manual testing scenarios using dev servers
  • CI validation commands

Repository Navigation

  • Monorepo structure explanation (packages vs apps)
  • Key directories and their purposes
  • Important configuration files
  • Component development workflow

Critical Operational Details

  • Explicit timeout warnings for long-running commands
  • Known issues and workarounds (docs build failures, engine warnings)
  • Package manager restrictions and workspace commands
  • Conventional commit requirements

Validation

All commands were thoroughly tested in a fresh clone environment to ensure accuracy. The instructions include measured timing for builds and tests, with explicit "NEVER CANCEL" warnings for long-running operations.

The instructions start with a firm directive to follow them first before falling back to search or additional context gathering, as requested.

Fixes #2813.

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:

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

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

@bolt-new-by-stackblitz
Copy link

bolt-new-by-stackblitz bot commented Aug 19, 2025

Review PR in StackBlitz Codeflow Run & review this pull request in StackBlitz Codeflow.

Copilot AI changed the title [WIP] ✨ Set up Copilot instructions Add comprehensive GitHub Copilot instructions for repository development Aug 19, 2025
Copilot AI requested a review from VividLemon August 19, 2025 23:49
VividLemon
VividLemon reviewed Aug 19, 2025
View reviewed changes
@VividLemon VividLemon marked this pull request as ready for review August 19, 2025 23:54
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Aug 19, 2025

Important

Review skipped

Bot user detected.

To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Join our Discord community for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR/Issue comments)

Type @coderabbitai help to get the list of available commands.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Status, Documentation and Community

  • Visit our Status Page to check the current availability of CodeRabbit.
  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@VividLemon VividLemon merged commit 3a8c487 into main Aug 19, 2025
4 checks passed
@pkg-pr-new
Copy link

pkg-pr-new bot commented Aug 19, 2025

bsvn-vite-ts

npm i https://pkg.pr.new/bootstrap-vue-next/bootstrap-vue-next@2814

npm i https://pkg.pr.new/bootstrap-vue-next/bootstrap-vue-next/@bootstrap-vue-next/nuxt@2814

commit: 046ebaf

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

Reviewers

@VividLemon VividLemon VividLemon left review comments

Assignees

@VividLemon VividLemon

Copilot code review Copilot

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

✨ Set up Copilot instructions

2 participants

@VividLemon