Add comprehensive GitHub Copilot instructions for go-workflows development - #401
Merged
Conversation
Co-authored-by: cschleiden <2201819+cschleiden@users.noreply.github.com>
Co-authored-by: cschleiden <2201819+cschleiden@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] ✨ Set up Copilot instructions
Add comprehensive GitHub Copilot instructions for go-workflows development
Aug 14, 2025
cschleiden
marked this pull request as ready for review
August 14, 2025 18:31
cschleiden
enabled auto-merge
August 14, 2025 18:31
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 detailed guidance for GitHub Copilot coding agents working in the go-workflows codebase.What's Included
The instructions cover all essential development workflows with validated commands and measured timing expectations:
Build and Test Setup
go mod download- 3.5 minutes)go build -v ./...- 40 seconds)Development Tools
Validation Scenarios
Specific manual testing scenarios to verify workflow functionality:
Repository Navigation
Critical Features
Timeout Specifications: Every long-running command includes explicit timeout recommendations and "NEVER CANCEL" warnings to prevent premature termination of builds that can take several minutes.
Validated Commands: All instructions have been tested and validated to work correctly in the current codebase state, including handling of known issues like analyzer plugin version conflicts.
Practical Examples: Real workflow execution examples with expected outputs to help agents verify their changes work correctly.
This enables GitHub Copilot agents to work effectively in the codebase without extensive exploration, reducing development time and preventing common setup mistakes.
Fixes #400.
💡 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.