Skip to content

Add comprehensive GitHub Copilot instructions for go-workflows development - #401

Merged
cschleiden merged 5 commits into
mainfrom
copilot/fix-400
Aug 14, 2025
Merged

Add comprehensive GitHub Copilot instructions for go-workflows development#401
cschleiden merged 5 commits into
mainfrom
copilot/fix-400

Conversation

Copilot AI commented Aug 14, 2025

Copy link
Copy Markdown
Contributor

This PR adds a comprehensive .github/copilot-instructions.md file 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

  • Complete dependency installation (go mod download - 3.5 minutes)
  • Full build process (go build -v ./... - 40 seconds)
  • Test execution with proper timeouts (short tests - 45 seconds, full suite - 2.5 minutes)
  • Docker Compose setup for development dependencies (13 seconds)

Development Tools

  • Analyzer plugin compilation for custom linting rules
  • golangci-lint setup and execution
  • JUnit test reporting configuration

Validation Scenarios

Specific manual testing scenarios to verify workflow functionality:

  • Basic end-to-end workflow execution
  • Multi-backend testing (Redis, SQLite, MySQL)
  • Complex workflow patterns (subworkflows, timers, signals)
  • Sample application verification

Repository Navigation

  • Key directory structure and purposes
  • Important files and configuration
  • Backend implementations and their use cases
  • Sample applications demonstrating different patterns

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.

Copilot AI and others added 2 commits August 14, 2025 18:22
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
Copilot AI requested a review from cschleiden August 14, 2025 18:26
@cschleiden
cschleiden marked this pull request as ready for review August 14, 2025 18:31
@cschleiden
cschleiden enabled auto-merge August 14, 2025 18:31
@cschleiden
cschleiden merged commit f21dabc into main Aug 14, 2025
4 checks passed
@cschleiden
cschleiden deleted the copilot/fix-400 branch August 14, 2025 20:32
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