Add comprehensive GitHub Copilot instructions for ProxiFyre development #90
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Co-authored-by: wiresock <20592735+wiresock@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] ✨+Set+up+Copilot+instructions
Add comprehensive GitHub Copilot instructions for ProxiFyre development
Sep 4, 2025
Copilot finished work on behalf of
wiresock
September 4, 2025 11:17
wiresock
approved these changes
Sep 4, 2025
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR adds comprehensive GitHub Copilot instructions for the ProxiFyre SOCKS5 proxifier project, providing detailed guidance for development tasks in a Windows-specific codebase. The instructions emphasize platform requirements, build processes, and validation procedures.
Key changes:
- Platform-specific guidance with clear Windows-only build requirements
- Detailed build instructions with proper timeout recommendations for long-running operations
- Manual validation scenarios for testing SOCKS5 proxy functionality
Comment on lines
+26
to
+28
| 3. **vcpkg Package Manager**: | ||
| ```cmd | ||
| git clone https://github.com/Microsoft/vcpkg.git |
There was a problem hiding this comment.
The vcpkg repository URL uses the deprecated Microsoft organization. The correct URL should be https://github.com/microsoft/vcpkg.git (lowercase 'microsoft') as the Microsoft/vcpkg repository has been moved.
Suggested change
| 3. **vcpkg Package Manager**: | |
| ```cmd | |
| git clone https://github.com/Microsoft/vcpkg.git | |
| git clone https://github.com/microsoft/vcpkg.git |
Comment on lines
+183
to
+205
| ```bash | ||
| # Root directory listing | ||
| ls -la | ||
| # Output: ProxiFyre/, socksify/, ndisapi.lib/, include/, netlib/, sign/, README.md, socksify.sln | ||
|
|
||
| # Key configuration files | ||
| find . -name "*.json" -o -name "*.config" -o -name "packages.config" | ||
| # Output: ./ProxiFyre/App.config, ./ProxiFyre/NLog.config, ./ProxiFyre/packages.config | ||
|
|
||
| # Project structure | ||
| find . -name "*.csproj" -o -name "*.vcxproj" -o -name "*.sln" | ||
| # Output: ./ProxiFyre/ProxiFyre.csproj, ./socksify/socksify.vcxproj, ./ndisapi.lib/ndisapilib.vcxproj, ./socksify.sln | ||
| ``` | ||
|
|
||
| ### Source Code Analysis | ||
| ```bash | ||
| # Find C# files | ||
| find . -name "*.cs" | ||
| # Output: ./ProxiFyre/Program.cs, ./ProxiFyre/Properties/AssemblyInfo.cs | ||
|
|
||
| # Find C++ files | ||
| find . -name "*.cpp" -o -name "*.h" | ||
| # Output: socksify/ and ndisapi/ directories contain C++ implementation |
There was a problem hiding this comment.
The bash commands are inconsistent with the Windows-only nature of the project documented earlier. Since this is explicitly a Windows-only application, PowerShell commands would be more appropriate: Get-ChildItem instead of ls -la, and Get-ChildItem -Recurse -Include instead of find.
Suggested change
| ```bash | |
| # Root directory listing | |
| ls -la | |
| # Output: ProxiFyre/, socksify/, ndisapi.lib/, include/, netlib/, sign/, README.md, socksify.sln | |
| # Key configuration files | |
| find . -name "*.json" -o -name "*.config" -o -name "packages.config" | |
| # Output: ./ProxiFyre/App.config, ./ProxiFyre/NLog.config, ./ProxiFyre/packages.config | |
| # Project structure | |
| find . -name "*.csproj" -o -name "*.vcxproj" -o -name "*.sln" | |
| # Output: ./ProxiFyre/ProxiFyre.csproj, ./socksify/socksify.vcxproj, ./ndisapi.lib/ndisapilib.vcxproj, ./socksify.sln | |
| ``` | |
| ### Source Code Analysis | |
| ```bash | |
| # Find C# files | |
| find . -name "*.cs" | |
| # Output: ./ProxiFyre/Program.cs, ./ProxiFyre/Properties/AssemblyInfo.cs | |
| # Find C++ files | |
| find . -name "*.cpp" -o -name "*.h" | |
| # Output: socksify/ and ndisapi/ directories contain C++ implementation | |
| ```powershell | |
| # Root directory listing | |
| Get-ChildItem -Force | |
| # Output: ProxiFyre/, socksify/, ndisapi.lib/, include/, netlib/, sign/, README.md, socksify.sln | |
| # Key configuration files | |
| Get-ChildItem -Recurse -Include *.json,*.config,packages.config | |
| # Output: .\ProxiFyre\App.config, .\ProxiFyre\NLog.config, .\ProxiFyre\packages.config | |
| # Project structure | |
| Get-ChildItem -Recurse -Include *.csproj,*.vcxproj,*.sln | |
| # Output: .\ProxiFyre\ProxiFyre.csproj, .\socksify\socksify.vcxproj, .\ndisapi.lib\ndisapilib.vcxproj, .\socksify.sln |
Source Code Analysis
# Find C# files
Get-ChildItem -Recurse -Include *.cs
# Output: .\ProxiFyre\Program.cs, .\ProxiFyre\Properties\AssemblyInfo.cs
# Find C++ files
Get-ChildItem -Recurse -Include *.cpp,*.h
# Output: socksify\ and ndisapi\ directories contain C++ implementation
Comment on lines
+198
to
+205
| ```bash | ||
| # Find C# files | ||
| find . -name "*.cs" | ||
| # Output: ./ProxiFyre/Program.cs, ./ProxiFyre/Properties/AssemblyInfo.cs | ||
|
|
||
| # Find C++ files | ||
| find . -name "*.cpp" -o -name "*.h" | ||
| # Output: socksify/ and ndisapi/ directories contain C++ implementation |
There was a problem hiding this comment.
Similar to the previous comment, these bash commands should be replaced with Windows-appropriate PowerShell commands for consistency with the Windows-only platform requirement: Get-ChildItem -Recurse -Include *.cs and Get-ChildItem -Recurse -Include *.cpp,*.h.
Suggested change
| ```bash | |
| # Find C# files | |
| find . -name "*.cs" | |
| # Output: ./ProxiFyre/Program.cs, ./ProxiFyre/Properties/AssemblyInfo.cs | |
| # Find C++ files | |
| find . -name "*.cpp" -o -name "*.h" | |
| # Output: socksify/ and ndisapi/ directories contain C++ implementation | |
| ```powershell | |
| # Find C# files | |
| Get-ChildItem -Recurse -Filter *.cs | |
| # Output: .\ProxiFyre\Program.cs, .\ProxiFyre\Properties\AssemblyInfo.cs | |
| # Find C++ files | |
| Get-ChildItem -Recurse -Include *.cpp,*.h -File | |
| # Output: socksify\ and ndisapi\ directories contain C++ implementation |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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 instructions for working effectively in the ProxiFyre codebase.Key Features
Platform-Specific Guidance: The instructions clearly document that ProxiFyre is a Windows-only application requiring specific dependencies (Windows Packet Filter, Visual Studio Runtime, vcpkg) and provide explicit warnings about build limitations on Linux/macOS environments.
Precise Build Instructions: Includes exact commands for:
ms-gsl,boost-pool)Critical Timing Information: Documents expected build times with proper timeout recommendations:
Manual Validation Scenarios: Provides specific steps for testing functionality:
/logsdirectoryRepository Navigation: All documented commands have been validated to work correctly, including file structure navigation, project discovery, and source code analysis.
Example Usage
The instructions enable agents to quickly understand the codebase structure:
The instructions start with a firm directive to always follow the provided guidance and only fallback to additional search when information is incomplete or found to be in error, as requested in the requirements.
Fixes #89.
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/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.