Skip to content

Conversation

Copy link
Contributor

Copilot AI commented Aug 17, 2025

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

What's Included

The instructions cover the complete developer workflow for Standard, a Nix Flakes-based DevOps framework:

Prerequisites & Setup

  • Nix package manager installation (with multiple installation methods)
  • direnv setup for automatic environment loading
  • Shell configuration for proper integration

Development Workflow

  • Environment setup: direnv allow with timing expectations (5-15 minutes first time)
  • Build commands: nix build and nix flake check with explicit timeout warnings (45-60 minutes)
  • Testing: namaka snapshot tests and full CI validation
  • Formatting/Linting: treefmt and reuse requirements (mandatory for CI)

Critical Timing Guidelines

  • "NEVER CANCEL" warnings for all long-running operations
  • Specific timeout recommendations: 45+ minutes for builds, 30+ minutes for tests
  • Realistic timing expectations: Based on Nix's caching behavior and Standard's complexity

Manual Validation Scenarios

  • Fresh environment setup validation
  • Complete development cycle testing
  • Template functionality verification
  • Subflake lock file management

Repository Navigation

  • Frequently accessed files clearly identified (e.g., src/local/shells.nix)
  • Standard framework concepts explained (Cells → Cell Blocks → Targets → Actions)
  • Common development patterns for extending the framework

Troubleshooting

  • Common error scenarios and solutions
  • Nix-specific debugging approaches
  • Environment reload procedures

Key Features

The instructions emphasize:

  1. Imperative tone: "Run this command", "Do not cancel builds"
  2. Exhaustive validation: Every critical workflow is documented
  3. Timing awareness: Explicit warnings about long-running operations
  4. Framework-specific guidance: Standard's unique organizational concepts

This enables GitHub Copilot to provide accurate, context-aware assistance for developers working with Standard's Nix-based DevOps framework, reducing onboarding time and preventing common mistakes like canceling long-running builds.

Fixes #409.

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:

  • install.determinate.systems
    • Triggering command: curl --connect-timeout 30 -L https://install.determinate.systems/nix (dns block)
  • 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:


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

Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

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

Copilot wasn't able to review any files in this pull request.


Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

Co-authored-by: blaggacao <7548295+blaggacao@users.noreply.github.com>
Copilot AI changed the title [WIP] ✨ Set up Copilot instructions Create comprehensive GitHub Copilot instructions for divnix/std repository Aug 17, 2025
Copilot finished work on behalf of blaggacao August 17, 2025 20:33
Copilot AI requested a review from blaggacao August 17, 2025 20:33
Copy link
Collaborator

@blaggacao blaggacao left a comment

Choose a reason for hiding this comment

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

Not perfect, but let's roll with it.

@blaggacao blaggacao marked this pull request as ready for review August 17, 2025 20:41
@blaggacao blaggacao merged commit 4177882 into main Aug 17, 2025
2 checks passed
@blaggacao blaggacao deleted the copilot/fix-409 branch August 17, 2025 20:42
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