Add comprehensive GitHub Copilot instructions for Roberts Lab resources repository#2276
Merged
Add comprehensive GitHub Copilot instructions for Roberts Lab resources repository#2276
Conversation
Copilot
AI
changed the title
[WIP] ✨ Set up Copilot instructions
Add comprehensive GitHub Copilot instructions for Roberts Lab resources repository
Aug 20, 2025
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.
This PR adds a comprehensive
.github/copilot-instructions.mdfile 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
Repository Structure & Navigation
docs/,protocols/,equipment_manuals/)mkdocs.yml,docs/requirements.txt,.readthedocs.yml)Validation Requirements
mkdocs build+ development server testing)Troubleshooting & Common Issues
Validation completed
All documented commands have been thoroughly tested:
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.