Skip to content

Conversation

Copy link
Contributor

Copilot AI commented Sep 8, 2025

The existing .github/copilot-instructions.md file contained several inaccuracies and missing critical information that could lead to coding agent failures. This PR updates the instructions with validated, accurate details based on comprehensive repository analysis.

Key Fixes

Corrected inaccurate repository structure information:

  • Fixed file counts: 31 R files (not 59), 14 C++ files (not 17), 30+ test files (not 61+)
  • Removed reference to non-existent .lintr file - linting uses default configuration with GitHub Actions output format
  • Updated dependency requirements based on actual DESCRIPTION file

Added missing critical dependency information:

  • Essential packages required for builds: ape, TreeTools, Rdpack, shinyjs, colorspace, Rcpp
  • System requirements: R 4.0+, C++17 compiler, 2GB+ RAM
  • Installation time expectations: 60+ minutes for full dependency chain from scratch

Enhanced pre-commit validation workflow:

  • Added working command sequences for dependency installation
  • Included basic build test without vignettes for quick validation
  • Documented that devtools::load_all() requires dependencies to be pre-installed

Comprehensive CI/CD documentation:

  • Documented all 7 GitHub workflows: R-CMD-check, benchmark, memcheck, ASan, RcppDeepState, pkgdown, revdepcheck
  • Added memory checking script information (memcheck/tests.R, memcheck/all.R)
  • Included troubleshooting for common build failures

Detailed troubleshooting section:

  • Common dependency installation issues and solutions
  • System package requirements for Ubuntu/Linux environments
  • Rdpack warning explanations (normal when package not installed)
  • TreeTools compilation time expectations (10+ minutes)

These improvements should significantly reduce the likelihood of coding agent PR rejections due to build failures, missing dependencies, or incorrect command usage. The instructions now provide a complete, validated workflow for successful TreeDist development.


💡 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.

Copilot AI changed the title [WIP] Your task is to "onboard" this repository to Copilot coding agent by adding a .github/copilot-instructions.md file in the repository that contains information describing how a coding agent seeing it for the first time can work most efficiently. You wi... Enhance Copilot instructions with validated build and configuration details Sep 8, 2025
Copilot AI requested a review from ms609 September 8, 2025 09:49
@ms609 ms609 marked this pull request as ready for review September 8, 2025 09:57
@ms609 ms609 merged commit decb693 into main Sep 8, 2025
1 of 5 checks passed
@ms609 ms609 deleted the copilot/fix-d23ac7fc-ed66-43e2-a881-17a801d60b38 branch September 8, 2025 09: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.

2 participants