Skip to content

Conversation

Copy link
Contributor

Copilot AI commented Aug 14, 2025

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

Key Features

The instructions include:

Validated Build & Test Commands:

  • Exact build commands with verified timing (5-6s normal, 3-4min with dependencies)
  • Core test commands that work without external credentials
  • Linting setup with proper golangci-lint installation
  • Critical "NEVER CANCEL" warnings with specific timeout values (300s+ for builds, 180s+ for linting)

Comprehensive Validation Scenarios:

  • 10 basic validation tests covering all major CLI functionality
  • Error handling validation for invalid providers and missing files
  • Tests using providers that work without external dependencies (echo, file, envsubst)

Developer Workflow Guidance:

  • Repository structure navigation with key directories explained
  • 28+ provider ecosystem overview
  • Development patterns and debugging tips
  • Pre-commit validation requirements

Manual Testing Examples:

# Basic functionality test
echo 'test: ref+echo://hello-world' | ./bin/vals eval -f -

# File provider test with existing test files
echo 'test: ref+file://./myjson.json#/baz/mykey' | ./bin/vals eval -f -

# Environment variable substitution
export VAR1=hello-world && echo 'test: ref+envsubst://$VAR1' | ./bin/vals eval -f -

All commands and scenarios have been thoroughly tested and validated to ensure they work correctly for any developer or AI agent starting fresh with this repository.

The instructions start with a firm directive to follow the provided guidance before falling back to additional search, as requested in the requirements.

Fixes #743.

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:

  • metadata.google.internal
  • vals-test.vault.azure.net
    • Triggering command: /tmp/go-build2678667348/b1767/vals.test -test.paniconexit0 -test.gocoverdir=/tmp/go-build2678667348/b1767/gocoverdir -test.timeout=10m0s -test.v=true -test.coverprofile=/tmp/go-build2678667348/b1767/_cover_.out (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.

Copilot AI changed the title [WIP] ✨ Set up Copilot instructions Add comprehensive GitHub Copilot instructions for vals repository Aug 14, 2025
Copilot AI requested a review from yxxhero August 14, 2025 23:49
@yxxhero yxxhero marked this pull request as ready for review August 14, 2025 23:53
@yxxhero yxxhero merged commit 5acb2fc into main Aug 14, 2025
9 checks passed
CorentinPtrl pushed a commit to CorentinPtrl/vals that referenced this pull request Oct 8, 2025
…lmfile#744)

* Initial plan

* Initial plan for GitHub Copilot instructions

Co-authored-by: yxxhero <[email protected]>

* Add comprehensive GitHub Copilot instructions

Co-authored-by: yxxhero <[email protected]>

* Enhance GitHub Copilot instructions with comprehensive validation scenarios

Co-authored-by: yxxhero <[email protected]>

---------

Co-authored-by: copilot-swe-agent[bot] <[email protected]>
Co-authored-by: yxxhero <[email protected]>
Signed-off-by: CorentinPtrl <[email protected]>
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