Add comprehensive GitHub Copilot instructions for documentation repository#5
Draft
Add comprehensive GitHub Copilot instructions for documentation repository#5
Conversation
…pository Co-authored-by: sr320 <4442039+sr320@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] ✨ Set up Copilot instructions
Add comprehensive GitHub Copilot instructions for documentation repository
Aug 28, 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 clear guidance on how to work effectively in the project-white-whale repository.Key Features
Documentation-Focused Instructions: Since this is a research documentation repository (not a code repository), the instructions focus on:
Comprehensive Coverage: The instructions include:
Imperative and Actionable: Following the requirements, the instructions use imperative tone throughout with clear directives like "Always validate", "Check all", "Ensure consistent", providing 23+ specific commands and guidance points.
Validated Content: All referenced files and statistics have been verified:
The instructions enable GitHub Copilot to understand this repository's unique context as a research documentation project focused on cataloging Crassostrea gigas RNA-seq and DNA methylation datasets, providing clear guidance for maintaining documentation quality and research methodology consistency.
Fixes #4.
💡 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.