chore: Add AI instructions #1484
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR replaces the minimal and incorrect copilot instructions file with comprehensive, validated instructions for working with the duckdb-r repository. The previous file incorrectly referenced "dm Package" instead of duckdb-r and provided no useful guidance.
Key Improvements
Validated Commands and Timing: All build and test commands have been executed and timed to provide accurate expectations:
Critical Timeout Warnings: Added explicit "NEVER CANCEL" warnings with specific timeout values (30+ minutes for builds, 5+ minutes for tests) to prevent premature cancellation of long-running operations.
Manual Validation Scenarios: Included complete end-to-end testing scenarios that agents should run after making changes:
Repository Structure Guidance: Documented the layout of 1700+ C++ files, 40+ test files, and key directories with clear guidance on what should and shouldn't be modified.
System Dependencies: Provided exact installation commands for R, build tools, and optional formatting dependencies.
Expected Issues: Documented known formatting differences and expected test failures to avoid confusion.
Updated CLAUDE.md: Enhanced the existing operational instructions file with the same comprehensive information, making it consistent with the GitHub Copilot instructions and providing detailed guidance for developers working on the repository.
The instructions follow the firm directive requirement to "always reference these instructions first and fallback to search or bash commands only when you encounter unexpected information that does not match the info here."
Fixes #1483.
💡 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.