Skip to content

Add comprehensive GitHub Copilot instructions for Roberts Lab resources repository#2276

Merged
sr320 merged 1 commit intomasterfrom
copilot/fix-2275
Aug 20, 2025
Merged

Add comprehensive GitHub Copilot instructions for Roberts Lab resources repository#2276
sr320 merged 1 commit intomasterfrom
copilot/fix-2275

Conversation

Copy link
Contributor

Copilot AI commented Aug 20, 2025

This PR adds a comprehensive .github/copilot-instructions.md file that provides GitHub Copilot coding agents with detailed guidance for working effectively in the Roberts Lab resources repository.

What this adds

The instruction file provides imperative, actionable guidance covering:

Build System & Validation

  • MkDocs with Material theme build process (~1 second build time)
  • Development server setup and testing procedures
  • Explicit timeout values (30+ seconds for builds, 300+ seconds for deployments)
  • "NEVER CANCEL" warnings for all time-consuming operations

Repository Structure & Navigation

  • Complete directory layout (docs/, protocols/, equipment_manuals/)
  • Configuration files (mkdocs.yml, docs/requirements.txt, .readthedocs.yml)
  • GitHub Actions workflows for auto-deployment and URL checking

Validation Requirements

  • Mandatory manual testing scenarios (homepage, computing guides, protocols)
  • Pre-commit validation steps (mkdocs build + development server testing)
  • Expected build warnings and success indicators
  • Quality assurance guidelines for content changes

Troubleshooting & Common Issues

  • Network timeout handling for pip installations
  • Theme fallback options (readthedocs theme when material theme unavailable)
  • Common build warnings that are expected and normal
  • Performance expectations and timing guidelines

Validation completed

All documented commands have been thoroughly tested:

  • ✅ Build process timing measured (~1 second consistently)
  • ✅ Development server functionality verified
  • ✅ Manual validation scenarios tested (homepage, computing guides, protocols accessible)
  • ✅ Dependency installation process documented with fallback options
  • ✅ GitHub Actions workflow commands validated

The instructions follow the imperative tone requirement ("Run this command", "Do not do this") and provide exhaustive detail to ensure any developer can follow the instructions and have them work reliably.

Fixes #2275.


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

@sr320 sr320 marked this pull request as ready for review August 20, 2025 22:31
@sr320 sr320 merged commit 383cdce into master Aug 20, 2025
3 checks passed
@sr320 sr320 deleted the copilot/fix-2275 branch August 20, 2025 22:31
Copilot AI restored the copilot/fix-2275 branch August 20, 2025 22:34
Copilot AI changed the title [WIP] ✨ Set up Copilot instructions Add comprehensive GitHub Copilot instructions for Roberts Lab resources repository Aug 20, 2025
Copilot AI requested a review from sr320 August 20, 2025 22:42
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