Skip to content

Add comprehensive GitHub Copilot instructions for UPLC-CAPE development#13

Merged
Unisay merged 1 commit into
mainfrom
copilot/fix-12
Aug 15, 2025
Merged

Add comprehensive GitHub Copilot instructions for UPLC-CAPE development#13
Unisay merged 1 commit into
mainfrom
copilot/fix-12

Conversation

Copilot AI commented Aug 15, 2025

Copy link
Copy Markdown
Contributor

This PR adds a comprehensive .github/copilot-instructions.md file that provides GitHub Copilot coding agents with everything they need to work effectively in the UPLC-CAPE codebase from a fresh clone.

Key Features

Environment Setup & Build Instructions

  • Step-by-step onboarding for fresh clones with exact commands
  • Nix development environment setup with proper timeout expectations
  • Build and test workflow with validated timing data from CI runs

Critical Timeout Guidance

  • 5 explicit "NEVER CANCEL" warnings for long-running operations
  • 11 timeout specifications with exact minute values based on real CI analysis
  • Nix dev shell: 5+ minutes (actual: ~2 minutes from CI)
  • Full validation pipeline: 15+ minutes (actual: ~4 minutes from CI)

Validated Commands & Workflows
All command examples have been tested against the actual CLI:

cape benchmark list                    # List benchmarks
cape submission new fibonacci Aiken 1.0.8 myhandle  # Create submission
cape submission validate --all        # Validate submissions
cape test                             # Run test suite
treefmt                              # Format code

Manual Testing Scenarios
Three complete validation workflows for post-change testing:

  1. Benchmark creation workflow with file verification
  2. Submission creation workflow with validation steps
  3. CLI help system testing

Project Structure & Templates

  • Key directories explanation with actual file listings
  • JSON templates matching the repository's schema files
  • Troubleshooting guide for common Nix environment issues

The instructions follow an imperative tone ("Run this", "Validate that") and prioritize known working solutions over exploration, enabling agents to work confidently without trial-and-error.

Fixes #12.

Warning

Firewall rules blocked me from connecting to one or more addresses

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

  • nixos.org
    • Triggering command: curl -L REDACTED (dns block)

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


💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

@Unisay Unisay marked this pull request as ready for review August 15, 2025 13:46
Copilot AI changed the title [WIP] ✨ Set up Copilot instructions Add comprehensive GitHub Copilot instructions for UPLC-CAPE development Aug 15, 2025
Copilot AI requested a review from Unisay August 15, 2025 13:58
@Unisay Unisay merged commit 003f25b into main Aug 15, 2025
2 checks passed
@Unisay Unisay deleted the copilot/fix-12 branch August 15, 2025 13:58
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