Skip to content

✨ Enhance Copilot instructions with comprehensive guidance - #44

Merged
IvoLeist merged 3 commits into
mainfrom
copilot/setup-copilot-instructions
Jan 19, 2026
Merged

✨ Enhance Copilot instructions with comprehensive guidance#44
IvoLeist merged 3 commits into
mainfrom
copilot/setup-copilot-instructions

Conversation

Copilot AI commented Oct 14, 2025

Copy link
Copy Markdown
Contributor

Overview

This PR enhances the .github/copilot-instructions.md file 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

  • Syntax Error: Fixed missing closing backtick on the 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:

  1. Project Overview - Brief description of the voting system as an R package containing a Shiny application

  2. Project Structure - Detailed documentation of:

    • R package source code organization (/R/)
    • Module files (mod_*.R) and their purposes
    • Bundled resources (/inst/shiny-app/)
    • Test structure (/tests/testthat/)
    • External environment (app_env/)
  3. Enhanced Coding Conventions - Added specific examples:

    • UI function naming: <module>UI (e.g., votingUI)
    • Server function naming: <module>Server (e.g., votingServer)
    • Module file naming with examples
    • Documentation requirements (roxygen2)
  4. Enhanced Testing - Added information about:

    • Helper file conventions (helper-*.R)
    • Module testing with testServer
  5. Build and Development - Complete command reference:

    • Building: make build or R CMD build .
    • Installing: make install
    • Running: make run or R -e "ShinyImgVoteR::run_app()"
    • Checking: make check
    • Documentation generation
  6. Configuration - Documented:

    • Config file location
    • Environment variables (IMGVOTER_BASE_DIR, IMGVOTER_CONFIG_FILE_PATH, IMGVOTER_IMAGES_DIR)
  7. Key Workflows - Quick reference for:

    • Development workflow: make dev
    • CI/CD simulation: make ci
    • Application startup sequence
  8. Database - Information about:

    • SQLite database usage
    • Database utilities location
    • Schema overview
  9. Important Notes - Architecture decisions:

    • R package design rationale
    • External data organization
    • Resource referencing with get_app_dir()

Benefits

This enhancement will help GitHub Copilot:

  • Better understand the project structure and architecture
  • Generate code that follows project conventions
  • Suggest appropriate commands for common tasks
  • Maintain consistency with existing patterns

The instructions maintain consistency with the existing AGENTS.md file while providing more detailed, actionable guidance specifically for Copilot.

Closes #<issue_number>

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)

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.

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
Copilot AI requested a review from IvoLeist October 14, 2025 17:14
@IvoLeist
IvoLeist marked this pull request as ready for review January 19, 2026 12:22
@IvoLeist
IvoLeist merged commit 62adbea into main Jan 19, 2026
1 check passed
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