Skip to content

Closes #2920 add copilot instructions#2983

Open
jeffreyad wants to merge 29 commits intomainfrom
2920-add-copilot-instructions
Open

Closes #2920 add copilot instructions#2983
jeffreyad wants to merge 29 commits intomainfrom
2920-add-copilot-instructions

Conversation

@jeffreyad
Copy link
Collaborator

@jeffreyad jeffreyad commented Feb 17, 2026

Thank you for your Pull Request! We have developed this task checklist from the Development Process Guide to help with the final steps of the process. Completing the below tasks helps to ensure our reviewers can maximize their time on your code as well as making sure the admiral codebase remains robust and consistent.

Please check off each taskbox as an acknowledgment that you completed the task or check off that it is not relevant to your Pull Request. This checklist is part of the Github Action workflows and the Pull Request will not be merged into the main branch until you have checked off each task.

  • Place Closes #<insert_issue_number> into the beginning of your Pull Request Title (Use Edit button in top-right if you need to update)
  • Code is formatted according to the tidyverse style guide. Run styler::style_file() to style R and Rmd files
  • Updated relevant unit tests or have written new unit tests, which should consider realistic data scenarios and edge cases, e.g. empty datasets, errors, boundary cases etc. - See Unit Test Guide
  • If you removed/replaced any function and/or function parameters, did you fully follow the deprecation guidance?
  • Review the Cheat Sheet. Make any required updates to it by editing the file inst/cheatsheet/admiral_cheatsheet.pptx and re-upload a PDF and a PNG version of it to the same folder. (The PNG version can be created by taking a screenshot of the PDF version.)
  • Update to all relevant roxygen headers and examples, including keywords and families. Refer to the categorization of functions to tag appropriate keyword/family.
  • Run devtools::document() so all .Rd files in the man folder and the NAMESPACE file in the project root are updated appropriately
  • Address any updates needed for vignettes and/or templates
  • Update NEWS.md under the header # admiral (development version) if the changes pertain to a user-facing function (i.e. it has an @export tag) or documentation aimed at users (rather than developers). A Developer Notes section is available in NEWS.md for tracking developer-facing issues.
  • Build admiral site pkgdown::build_site() and check that all affected examples are displayed correctly and that all new functions occur on the "Reference" page.
  • Address or fix all lintr warnings and errors - lintr::lint_package()
  • Run R CMD check locally and address all errors and warnings - devtools::check()
  • Link the issue in the Development Section on the right hand side.
  • Address all merge conflicts and resolve appropriately
  • Pat yourself on the back for a job well done! Much love to your accomplishment!

@github-actions
Copy link

github-actions bot commented Feb 17, 2026

Code Coverage

Package Line Rate Health
admiral 100%
Summary 100% (6131 / 6144)

jeffreyad and others added 7 commits February 18, 2026 15:42
- Synced latest admiraldev programming strategy
- Updated unit testing guidance
- Auto-generated on 2026-02-18 15:43:07 UTC

[skip ci]
- Synced latest admiraldev programming strategy
- Updated unit testing guidance
- Auto-generated on 2026-02-18 16:24:26 UTC

[skip ci]
- Synced latest admiraldev programming strategy
- Updated unit testing guidance
- Auto-generated on 2026-02-18 16:44:44 UTC

[skip ci]
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot encountered an error and was unable to review this pull request. You can try again by re-requesting a review.

jeffreyad and others added 3 commits February 18, 2026 12:24
- Synced latest admiraldev programming strategy
- Updated unit testing guidance
- Refreshed AGENT.md files for universal AI support
- Auto-generated on 2026-02-18 18:26:30 UTC

[skip ci]
Copy link
Collaborator

@bms63 bms63 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wondering if we could have a demo of this and more discussion at next deep-dive meeting?

actions-user and others added 7 commits February 18, 2026 18:44
- Synced latest admiraldev programming strategy
- Updated unit testing guidance
- Refreshed AGENT.md files for universal AI support
- Auto-generated on 2026-02-18 18:44:07 UTC

[skip ci]
- Synced latest admiraldev programming strategy
- Updated unit testing guidance
- Refreshed AGENT.md files for universal AI support
- Auto-generated on 2026-02-18 18:57:31 UTC

[skip ci]
- Synced latest admiraldev programming strategy
- Updated unit testing guidance
- Refreshed AGENT.md files for universal AI support
- Auto-generated on 2026-02-18 19:48:42 UTC

[skip ci]
- Synced latest admiraldev programming strategy
- Updated unit testing guidance
- Refreshed AGENT.md files for universal AI support
- Auto-generated on 2026-02-18 20:11:28 UTC

[skip ci]
@jeffreyad jeffreyad linked an issue Feb 18, 2026 that may be closed by this pull request
@jeffreyad
Copy link
Collaborator Author

The idea is that a GitHub action will periodically run a script that copies information from {admiraldev} Programming Strategy and Unit Test Guidance to AGENT.md files available for the coding agents. We can discuss in next deep-dive meeting.

jeffreyad and others added 2 commits February 23, 2026 10:16
- Synced latest admiraldev programming strategy
- Updated unit testing guidance
- Refreshed AGENT.md files for universal AI support
- Auto-generated on 2026-02-23 19:17:54 UTC

[skip ci]
@jeffreyad
Copy link
Collaborator Author

Will move this to {admiralci}

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 6 out of 6 changed files in this pull request and generated 3 comments.


💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment on lines +186 to +190
"**Auto-generated:** See commit history for last update date",
"**Source:** admiraldev package vignettes",
"**Update script:** `source('.github/scripts/sync_admiraldev_copilot.R')`",
"",
"## Purpose",
Copy link

Copilot AI Feb 27, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The script correctly generates "See commit history for last update date" (lines 186, 277, 349), but the actual output files (AGENTS.md, tests/testthat/AGENTS.md, .github/copilot-instructions.md) contain hardcoded timestamps "2026-02-23 19:17:54". This indicates these files were not generated by running this script. The files should be regenerated using this script to ensure consistency.

Copilot uses AI. Check for mistakes.
jeffreyad and others added 2 commits February 27, 2026 10:42
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
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.

General Issue: Add Copilot Instructions

4 participants