Skip to content

✨ Add comprehensive Copilot instructions#13

Merged
bfatemi merged 2 commits into
mainfrom
copilot/set-up-copilot-instructions
Dec 27, 2025
Merged

✨ Add comprehensive Copilot instructions#13
bfatemi merged 2 commits into
mainfrom
copilot/set-up-copilot-instructions

Conversation

Copilot AI commented Nov 18, 2025

Copy link
Copy Markdown
Contributor

Configures GitHub Copilot coding agent instructions per best practices to guide AI behavior for this R package.

Changes

Enhanced .github/copilot-instructions.md (124 lines) with:

  • Coding conventions: tidyverse style, roxygen2 requirements, explicit namespacing, CRAN compliance patterns
  • Testing standards: testthat 3rd edition, 80% coverage threshold, test file naming conventions
  • Security guidelines: temp file cleanup, permission handling, suggested package checks, input validation
  • Development workflow: restart R → document → test → check cycle with specific commands
  • Documentation patterns: roxygen2 block structure with complete working examples
  • Package architecture: logging system internals, path resolution order, RStudio addin patterns, versioning scheme
  • Code examples: suggested package usage, temp file handling, documentation templates
  • Operational guidance: preferred libraries from existing dependencies, commit message format

Maintains existing reference to AGENTS.md as authoritative source while providing quick reference optimized for Copilot consumption.

Original prompt

This section details on the original issue you should resolve

<issue_title>✨ Set up Copilot instructions</issue_title>
<issue_description>Configure instructions for this repository as documented in Best practices for Copilot coding agent in your repository.

</issue_description>

Comments on the Issue (you are @copilot in this section)


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

Co-authored-by: bfatemi <15960931+bfatemi@users.noreply.github.com>
Copilot AI changed the title [WIP] Configure instructions for Copilot in repository ✨ Add comprehensive Copilot instructions Nov 18, 2025
Copilot AI requested a review from bfatemi November 18, 2025 21:56
@bfatemi bfatemi marked this pull request as ready for review December 24, 2025 00:11
@bfatemi bfatemi merged commit 21e4c2e into main Dec 27, 2025
1 check passed
@bfatemi bfatemi deleted the copilot/set-up-copilot-instructions branch December 27, 2025 04: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