Skip to content

Conversation

Copy link
Contributor

Copilot AI commented Sep 16, 2025

This PR adds a comprehensive .github/copilot-instructions.md file that provides GitHub Copilot coding agents with detailed instructions for working effectively in the Protols codebase.

What's Included

The instructions file provides complete guidance for:

Build & Development Workflow:

  • Step-by-step setup with exact commands and validated timing expectations
  • Rust toolchain usage (cargo build ~1 min, cargo test ~6 sec, cargo clippy ~15 sec)
  • External dependency setup (protoc, clang-format) with verification commands
  • Critical timeout warnings ("NEVER CANCEL" with 90+ minute timeouts for builds)

Manual Validation Scenarios:

  • 4 comprehensive test scenarios covering build validation, dependency verification, LSP functionality testing, and sample file validation
  • Specific commands for testing core LSP features (hover, workspace operations, go-to-definition)
  • Integration testing with Protocol Buffer files using protoc and clang-format

Project Navigation & Structure:

  • Detailed source code organization (src/lsp.rs, src/parser/, src/workspace/, etc.)
  • Key files and their purposes (1400+ lines across 22 test modules)
  • Sample files for testing (sample/simple.proto, test input files)

Development Best Practices:

  • Common debugging workflows and log file locations
  • Performance expectations and timing guidelines
  • CI validation requirements (cargo fmt --check, cargo clippy, full test suite)

Validation

Every single command in the instructions has been tested and validated to work correctly:

  • ✅ All build commands execute successfully with measured timing
  • ✅ Full test suite passes (22 tests in ~6 seconds)
  • ✅ External dependencies (protoc 3.21.12, clang-format 18.1.3) verified
  • ✅ LSP functionality confirmed through specific test execution
  • ✅ Sample proto file processing validated

The instructions follow an imperative tone ("Run this command", "Always test") and provide copy-pasteable commands that agents can execute reliably to build, test, and validate changes to the Language Server Protocol implementation.

Fixes #92.

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:

  • esm.ubuntu.com
    • Triggering command: /usr/lib/apt/methods/https (dns block)

If you need me to access, download, or install something from one of these locations, you can either:


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

Copilot AI changed the title [WIP] ✨+Set+up+Copilot+instructions Add comprehensive .github/copilot-instructions.md for GitHub Copilot coding agent Sep 16, 2025
Copilot AI requested a review from coder3101 September 16, 2025 06:37
Copilot finished work on behalf of coder3101 September 16, 2025 06:37
@coder3101 coder3101 marked this pull request as ready for review September 20, 2025 17:26
@coder3101 coder3101 enabled auto-merge (squash) September 20, 2025 17:26
@coder3101 coder3101 disabled auto-merge September 20, 2025 17:29
@coder3101 coder3101 merged commit 9c47359 into main Sep 20, 2025
1 check passed
@coder3101 coder3101 deleted the copilot/fix-92 branch September 20, 2025 17:29
- `cargo fmt --check` -- should pass formatting check
- `cargo clippy` -- should pass linting with no warnings
- `./target/debug/protols --help` -- should show help message
- `./target/debug/protols --version` -- should show version 0.12.8

Choose a reason for hiding this comment

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

This should be 0.12.9 after the recent version bump. Maybe add a template script to keep {{VERSION}} updated automatically?

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

3 participants