Skip to content

Conversation

@JP-Ellis
Copy link
Contributor

📝 Summary

Add LLM instructions within .github/instructions/.

🚨 Breaking Changes

🔥 Motivation

This is to help give context to LLMs when/if they contribute to anything on this repo (whether as a standalone agent, or while helping a contributor).

While I would prefer a vendor-agnostic system, I also didn't want to litter this repository with a bunch of AGENTS.md files, and I like the applyTo syntax of the Copilot instruction files.

🔨 Test Plan

🔗 Related issues/PRs

Signed-off-by: JP-Ellis <josh@jpellis.me>
Copilot AI review requested due to automatic review settings October 10, 2025 00:54
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR adds LLM instruction files within .github/instructions/ to provide context and guidelines for AI assistants contributing to the repository. The instructions use GitHub Copilot's instruction file format with applyTo syntax to target specific file patterns.

  • Establishes coding conventions and documentation standards for Python code
  • Defines testing guidelines using pytest framework
  • Documents the structure and purpose of different package components (core library, V2 legacy, FFI, CLI)

Reviewed Changes

Copilot reviewed 6 out of 6 changed files in this pull request and generated no comments.

Show a summary per file
File Description
.github/instructions/python.instructions.md General Python coding conventions, documentation standards, and code style guidelines
.github/instructions/python-tests.instructions.md Testing conventions for pytest-based test files
.github/instructions/pact.instructions.md Guidelines for the core Pact library structure and key modules
.github/instructions/pact-v2.instructions.md Instructions for maintaining legacy V2 codebase in maintenance mode
.github/instructions/pact-ffi.instructions.md Guidelines for low-level FFI bindings package
.github/instructions/pact-cli.instructions.md Instructions for the CLI wrapper package

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

@codecov
Copy link

codecov bot commented Oct 10, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 52%. Comparing base (acd125d) to head (d729f07).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files
@@         Coverage Diff          @@
##           main   #1287   +/-   ##
====================================
  Coverage    52%     52%           
====================================
  Files        32      32           
  Lines      3739    3739           
====================================
  Hits       1966    1966           
  Misses     1773    1773           
Flag Coverage Δ
tests 52% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@JP-Ellis JP-Ellis enabled auto-merge (rebase) October 10, 2025 00:59
@JP-Ellis JP-Ellis merged commit 69db163 into main Oct 10, 2025
59 checks passed
@JP-Ellis JP-Ellis deleted the chore/add-llm-instructions branch October 10, 2025 01:01
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.

2 participants