Add comprehensive GitHub Copilot instructions for consumer-driven-contract-testing repository #6
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 on how to work effectively in this Consumer Driven Contract Testing workshop repository.Key Features
Validated Commands: All build, test, and run commands have been tested and timed to ensure they work correctly:
./mvnw clean compile(~30s first run, ~3s subsequent)./mvnw package -Dtest='!CustomerServiceTest#testGetCustomerByIdWithWireMockCloud'(~6-8s)./mvnw -pl {service} spring-boot:run(~1.5s each)Critical Timeout Guidance: Includes explicit "NEVER CANCEL" warnings with specific timeout recommendations (60+ minutes for builds, 30+ minutes for tests) to prevent premature cancellation of operations.
Known Issues Documentation: Documents the external network dependency failure in
CustomerServiceTest#testGetCustomerByIdWithWireMockCloudwith a working workaround using test exclusion.Manual Validation Scenarios: Provides step-by-step instructions for testing service integration and contract testing functionality after making changes.
Repository Context
This workshop repository demonstrates Consumer Driven Contract Testing with:
The instructions help agents understand this is a tutorial repository with intentionally incomplete contract configurations that are completed through the README exercises.
Fixes #5.
Warning
Firewall rules blocked me from connecting to one or more addresses (expand for details)
I tried to connect to the following addresses, but was blocked by firewall rules:
qgdoz.wiremockapi.cloud/usr/lib/jvm/temurin-17-jdk-amd64/bin/java -jar /home/REDACTED/work/consumer-driven-contract-testing/consumer-driven-contract-testing/invoice-service/target/surefire/surefirebooter-20250903112850603_3.jar /home/REDACTED/work/consumer-driven-contract-testing/consumer-driven-contract-testing/invoice-service/target/surefire 2025-09-03T11-28-50_544-jvmRun1 surefire-20250903112850603_1tmp surefire_0-20250903112850603_2tmp(dns block)/usr/lib/jvm/temurin-17-jdk-amd64/bin/java -jar /home/REDACTED/work/consumer-driven-contract-testing/consumer-driven-contract-testing/invoice-service/target/surefire/surefirebooter-20250903113025302_6.jar /home/REDACTED/work/consumer-driven-contract-testing/consumer-driven-contract-testing/invoice-service/target/surefire 2025-09-03T11-30-24_665-jvmRun1 surefire-20250903113025302_4tmp surefire_1-20250903113025302_5tmp(dns block)If you need me to access, download, or install something from one of these locations, you can either:
✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.