Skip to content

Add comprehensive GitHub Copilot instructions for BeatFlutter development#14

Draft
Copilot wants to merge 2 commits intomainfrom
copilot/fix-13
Draft

Add comprehensive GitHub Copilot instructions for BeatFlutter development#14
Copilot wants to merge 2 commits intomainfrom
copilot/fix-13

Conversation

Copy link

Copilot AI commented Aug 18, 2025

This PR adds a comprehensive .github/copilot-instructions.md file that provides GitHub Copilot with detailed instructions for working effectively in the BeatFlutter codebase.

What's Included

The instructions cover all essential aspects of developing with BeatFlutter:

  • Setup Requirements: Flutter SDK installation, protobuf compiler, and critical external dependency (FlutterMidiCommand)
  • Platform-Specific Builds: Detailed commands for Android, iOS, web, and macOS with correct Flutter channel switching
  • Build Time Expectations: Explicit timeout values (10-150+ minutes) with "NEVER CANCEL" warnings for long-running operations
  • Validation Commands: Pre-commit checks and dependency verification that work even without Flutter SDK
  • Testing Procedures: Unit tests, static analysis, and manual testing scenarios
  • Troubleshooting Guide: Common issues and their solutions
  • Repository Structure: Key files and directories for efficient navigation

Key Features

  • Imperative tone throughout ("Run this command", "Do not cancel", "Always check")
  • Starts with firm directive to follow instructions first before searching
  • 12 "NEVER CANCEL" warnings for build operations that can take 45+ minutes
  • 6 explicit timeout specifications to prevent premature cancellation
  • Platform-specific Flutter channel requirements (stable/beta/dev per platform)
  • External dependency documentation for required FlutterMidiCommand clone
  • Validation commands that work without full Flutter environment setup

Example Usage

# Critical external dependency setup
cd .. && git clone https://github.com/InvisibleWrench/FlutterMidiCommand.git

# Platform-specific builds with proper channels
flutter channel stable && flutter upgrade
./build-release-android  # 15-30 minutes - NEVER CANCEL

flutter channel beta && flutter upgrade  
./build-release-web      # 10-20 minutes - NEVER CANCEL

The instructions enable any developer (or coding agent) to quickly understand the codebase structure, set up the development environment correctly, and execute builds without common pitfalls like premature cancellation or missing dependencies.

Fixes #13.

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:

  • canonical-lgw01.cdn.snapcraftcontent.com
    • Triggering command: /usr/lib/snapd/snapd (dns block)
  • dl-ssl.google.com
    • Triggering command: wget -q -O - REDACTED (dns block)
  • esm.ubuntu.com
    • Triggering command: /usr/lib/apt/methods/https (dns block)
  • https://storage.googleapis.com/flutter_infra_release/flutter/1e9a811bf8e70466596bcf0ea3a8b5adb5f17f7f/dart-sdk-linux-x64.zip
    • Triggering command: curl --retry 3 --continue-at - --location --output /tmp/flutter/bin/cache/dart-sdk-linux-x64.zip REDACTED (http block)
  • https://storage.googleapis.com/flutter_infra_release/releases/stable/linux/flutter_linux_3.22.2-stable.tar.xz
    • Triggering command: wget -O flutter.tar.xz REDACTED (http block)

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.

Co-authored-by: JonLatane <127916+JonLatane@users.noreply.github.com>
Copilot AI changed the title [WIP] ✨ Set up Copilot instructions Add comprehensive GitHub Copilot instructions for BeatFlutter development Aug 18, 2025
Copilot AI requested a review from JonLatane August 18, 2025 15:29
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