Skip to content

Add UCD-SeRG Lab Manual reference to copilot-instructions#184

Merged
d-morrison merged 5 commits into
mainfrom
copilot/add-copilot-instructions-guidance
May 19, 2026
Merged

Add UCD-SeRG Lab Manual reference to copilot-instructions#184
d-morrison merged 5 commits into
mainfrom
copilot/add-copilot-instructions-guidance

Conversation

Copilot AI commented Jan 27, 2026

Copy link
Copy Markdown
Contributor

Adds reference to the UCD-SeRG Lab Manual in copilot-instructions to ensure Copilot follows lab-wide best practices for code repositories, coding style, reproducibility, and GitHub workflows.

Changes

  • Added new "Lab-Wide Guidance" section in .github/copilot-instructions.md with link to lab manual (web and GitHub source fallback)
  • Listed key manual topics: culture/conduct, communication, reproducibility, code repositories, coding practices, big data, Quarto, GitHub workflows, code publication
  • Updated NEWS.md and incremented version to 0.0.0.9048

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

  • ucd-serg.github.io
    • Triggering command: /home/REDACTED/work/_temp/ghcca-node/node/bin/node /home/REDACTED/work/_temp/ghcca-node/node/bin/node --enable-source-maps /home/REDACTED/work/_temp/copilot-developer-action-main/dist/index.js (dns block)

If you need me to access, download, or install something from one of these locations, you can either:

Original prompt

add to copilot-instructions: follow guidance in https://ucd-serg.github.io/lab-manual/; the corresponding source files are in https://github.com/UCD-SERG/lab-manual, if easier to read


✨ 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: d-morrison <2474437+d-morrison@users.noreply.github.com>
Copilot AI changed the title [WIP] Add guidance from lab manual for copilot instructions Add UCD-SeRG Lab Manual reference to copilot-instructions Jan 27, 2026
Copilot AI requested a review from d-morrison January 27, 2026 06:50
Comment thread .github/copilot-instructions.md
@d-morrison d-morrison marked this pull request as ready for review January 27, 2026 07:10
Copilot AI review requested due to automatic review settings January 27, 2026 07:10

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Adds lab-wide best-practices guidance to the repository’s Copilot instructions by linking to the UCD-SeRG Lab Manual, and updates release metadata accordingly.

Changes:

  • Added a new “Lab-Wide Guidance” section to .github/copilot-instructions.md linking to the UCD-SeRG Lab Manual (with a GitHub source fallback).
  • Added a NEWS entry documenting the Copilot-instructions update.
  • Bumped package version to 0.0.0.9048.

Reviewed changes

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

File Description
.github/copilot-instructions.md Adds lab-manual reference and topic list to guide Copilot toward lab-wide standards.
NEWS.md Records the Copilot-instructions update in the development changelog.
DESCRIPTION Increments package version to reflect the change.

Copilot AI review requested due to automatic review settings May 15, 2026 05:10
@github-actions github-actions Bot removed the request for review from Copilot May 15, 2026 05:11
Copilot AI review requested due to automatic review settings May 19, 2026 05:32
@d-morrison d-morrison merged commit fae21e8 into main May 19, 2026
12 of 14 checks passed
@d-morrison d-morrison deleted the copilot/add-copilot-instructions-guidance branch May 19, 2026 05:32
@github-actions github-actions Bot removed the request for review from Copilot May 19, 2026 05:32
@claude

claude Bot commented May 19, 2026

Copy link
Copy Markdown
Contributor

Claude finished @d-morrison's task in 43s —— View job


Code Review: PR #184 — Add UCD-SeRG Lab Manual reference to copilot-instructions

  • Gather context
  • Read changed files
  • Analyze changes
  • Post review feedback

Note: This PR is already merged. The review below is retrospective.


Summary

This PR adds a new "Lab-Wide Guidance" section to .github/copilot-instructions.md (lines 13–29) that points Copilot to the UCD-SeRG Lab Manual, and adds a single NEWS.md entry. The changes are minimal and low-risk.


Review

.github/copilot-instructions.md

Strengths:

  • The section is well-placed immediately after "Repository Overview", so it appears early and is likely to be read before Copilot processes anything else.
  • The GitHub source fallback (https://github.com/UCD-SERG/lab-manual) is a practical addition given that the firewall warning in the PR body confirms ucd-serg.github.io was inaccessible during the Copilot run. Without the fallback, the instruction would be effectively dead-letter for Copilot agents in that environment.
  • The topic list is appropriately broad and gives useful signal for what kinds of questions Copilot should consult the manual on.

Minor observations:

  • The instruction says "Follow the guidance…" (imperative, bolded) which is good — it's directive rather than suggestive.
  • The topics listed in the bullet list (lines 16–27) are not exhaustive and end with "And more", which is fine but slightly vague. If there are particularly high-priority topics (e.g., reproducibility, coding practices), listing those first or marking them would add clarity for skimming.
  • No conflict-resolution guidance is given: if the lab manual contradicts something elsewhere in copilot-instructions.md, Copilot has no signal about which wins. This is a minor nit — adding a sentence like "Where these conflict with repo-specific instructions below, prefer the repo-specific guidance" would prevent ambiguity.

NEWS.md

The added entry (line 30 in current file) accurately describes the change. Consistent with the project's changelog style.


Verdict

Clean, well-scoped change. The fallback link is the most important detail and it's handled correctly. The one actionable improvement would be adding a short precedence note to the new section, but this is not blocking.

@codecov

codecov Bot commented May 19, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ All tests successful. No failed tests found.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants