Skip to content

✨ Set up Copilot instructions for repository#348

Merged
mozillazg merged 2 commits intomasterfrom
copilot/fix-0f686d64-dfa7-4f7a-adf7-89dcc43552ae
Oct 2, 2025
Merged

✨ Set up Copilot instructions for repository#348
mozillazg merged 2 commits intomasterfrom
copilot/fix-0f686d64-dfa7-4f7a-adf7-89dcc43552ae

Conversation

Copy link
Contributor

Copilot AI commented Oct 2, 2025

This PR adds comprehensive Copilot instructions to help GitHub Copilot better understand and work with the ptcpdump codebase.

What's Changed

Created .github/copilot-instructions.md with detailed guidance covering:

  • Project Overview: Description of ptcpdump as an eBPF-powered packet analyzer with process/container/pod metadata annotation
  • Development Environment: Required tools (Go, Clang/LLVM, Bison, etc.) and setup instructions
  • Build & Test Commands: Clear commands for building (static/dynamic linking), testing (unit/e2e), and linting
  • Code Structure: Directory layout and purpose of key packages (bpf/, cmd/, internal/)
  • Coding Standards: Guidelines for Go formatting, C/eBPF code formatting with clang-format, and test conventions
  • eBPF-Specific Considerations: Important notes about kernel-space limitations, bytecode generation workflow, and cross-architecture testing
  • Container/Kubernetes Integration: Requirements for Docker, containerd, and Kubernetes metadata extraction
  • Performance Guidelines: Best practices for high-throughput packet capture
  • Common Development Tasks: Step-by-step workflows for adding features, fixing bugs, and modifying eBPF code
  • CI/CD Information: GitHub Actions (x86_64) and CircleCI (arm64) test infrastructure
  • Documentation Structure: Guide to README files, Hugo docs site, and CHANGELOG

Why This Matters

Following GitHub's best practices for Copilot coding agents, this instructions file will:

  1. Help Copilot provide more accurate code suggestions tailored to ptcpdump's architecture
  2. Guide contributors on proper development workflows, especially for eBPF code
  3. Ensure consistency with the project's coding standards and testing requirements
  4. Serve as a reference for both human developers and AI assistants

Closes the issue requesting Copilot instructions setup.

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 #347

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

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Oct 2, 2025

Important

Review skipped

Bot user detected.

To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.


Comment @coderabbitai help to get the list of available commands and usage tips.

Co-authored-by: mozillazg <485054+mozillazg@users.noreply.github.com>
Copilot AI changed the title [WIP] ✨ Set up Copilot instructions ✨ Set up Copilot instructions for repository Oct 2, 2025
Copilot AI requested a review from mozillazg October 2, 2025 12:50
@mozillazg mozillazg marked this pull request as ready for review October 2, 2025 13:02
@mozillazg mozillazg merged commit dd2d37d into master Oct 2, 2025
16 of 25 checks passed
@mozillazg mozillazg deleted the copilot/fix-0f686d64-dfa7-4f7a-adf7-89dcc43552ae branch October 2, 2025 13:02
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