Skip to content

Conversation

Copy link
Contributor

Copilot AI commented Oct 2, 2025

This PR adds comprehensive AI agent instructions to help AI coding agents and developers work more effectively with this repository.

What's Changed

Added AGENTS.md in the repository root with detailed guidance covering:

Repository Overview

  • Explains this is a pure Haskell implementation of Google's Protocol Buffers
  • Uses GHC.Generics for automatic encoding/decoding without requiring .proto files
  • Supports Required, Optional, Repeated, and Packed fields with type-safe field tags

Build & Test Instructions

Clear commands for working with the Cabal build system:

cabal build --enable-tests --enable-benchmarks
cabal test --enable-tests
cabal check

Code Guidelines

  • Language extensions commonly used (DeriveGeneric, DataKinds, OverloadedStrings, etc.)
  • Naming conventions and code structure
  • Documentation standards using Haddock

Project Architecture

  • Core modules and their responsibilities
  • Field types and key type classes (Encode, Decode, HasField)
  • Testing approach using Tasty framework with QuickCheck and HUnit
  • GHC version compatibility matrix (8.10.7 through 9.8.4)

Development Workflow

  • Best practices before making changes
  • Validation steps after changes
  • Common pitfalls to avoid (wire format compatibility, field tag uniqueness, type-level programming gotchas)

Dependencies & Limitations

  • Lists key dependencies and dependency management philosophy
  • Documents known limitations (default values, extension fields, unknown fields)

This provides context-aware assistance for both AI agents and human contributors.

Fixes #43

Original prompt

This section details on the original issue you should resolve

<issue_title>✨+Set+up+Copilot+instructions</issue_title>
<issue_description>Configure instructions for this repository as documented in Best practices for Copilot coding agent in your repository.

</issue_description>

Comments on the Issue (you are @copilot in this section)

Fixes #43

💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.

Co-authored-by: NathanHowell <170829+NathanHowell@users.noreply.github.com>
Copilot AI changed the title [WIP] ✨+Set+up+Copilot+instructions ✨ Set up Copilot instructions for the repository Oct 2, 2025
Copilot AI requested a review from NathanHowell October 2, 2025 03:59
@@ -0,0 +1,149 @@
# GitHub Copilot Instructions for protobuf
Copy link
Member

Choose a reason for hiding this comment

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

please rename this file to /AGENTS.md and remove any Copilot specific wording

Copy link
Member

Choose a reason for hiding this comment

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

@copilot ptal

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done. Renamed to /AGENTS.md and removed Copilot-specific wording. The title is now "AI Agent Instructions for protobuf" and the file is in the repository root. (33bcd15)

Co-authored-by: NathanHowell <170829+NathanHowell@users.noreply.github.com>
Copilot AI changed the title ✨ Set up Copilot instructions for the repository ✨ Set up AI agent instructions for the repository Oct 2, 2025
Copilot AI requested a review from NathanHowell October 2, 2025 04:08
@NathanHowell NathanHowell marked this pull request as ready for review October 2, 2025 04:24
@NathanHowell NathanHowell merged commit cff6ab6 into master Oct 2, 2025
12 checks passed
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