✨ Enhance Copilot instructions with comprehensive guidance - #44
Merged
Conversation
Co-authored-by: IvoLeist <28399610+IvoLeist@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Set up Copilot instructions for repository
✨ Enhance Copilot instructions with comprehensive guidance
Oct 14, 2025
IvoLeist
marked this pull request as ready for review
January 19, 2026 12:22
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Overview
This PR enhances the
.github/copilot-instructions.mdfile to provide comprehensive guidance for GitHub Copilot when working with the B1MG Variant Voting repository, following best practices documented at https://gh.io/copilot-coding-agent-tips.Changes Made
Fixed Issues
covr::package_coverage()command (line 15)Enhancements
The Copilot instructions file has been significantly expanded from 15 lines to 78 lines with the following new sections:
Project Overview - Brief description of the voting system as an R package containing a Shiny application
Project Structure - Detailed documentation of:
/R/)mod_*.R) and their purposes/inst/shiny-app/)/tests/testthat/)app_env/)Enhanced Coding Conventions - Added specific examples:
<module>UI(e.g.,votingUI)<module>Server(e.g.,votingServer)Enhanced Testing - Added information about:
helper-*.R)testServerBuild and Development - Complete command reference:
make buildorR CMD build .make installmake runorR -e "ShinyImgVoteR::run_app()"make checkConfiguration - Documented:
IMGVOTER_BASE_DIR,IMGVOTER_CONFIG_FILE_PATH,IMGVOTER_IMAGES_DIR)Key Workflows - Quick reference for:
make devmake ciDatabase - Information about:
Important Notes - Architecture decisions:
get_app_dir()Benefits
This enhancement will help GitHub Copilot:
The instructions maintain consistency with the existing
AGENTS.mdfile while providing more detailed, actionable guidance specifically for Copilot.Closes #<issue_number>
Original prompt
Fixes #43
✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.