Add GitHub Copilot instructions for repository#30
Conversation
Co-authored-by: doublegate <6858123+doublegate@users.noreply.github.com>
doublegate
left a comment
There was a problem hiding this comment.
Approved for Use -- DG 11/18
There was a problem hiding this comment.
Pull request overview
This PR adds GitHub Copilot-specific instructions to guide AI-assisted code generation for the RustIRC project. The configuration file provides comprehensive documentation about the project's architecture, coding standards, and development practices to help Copilot generate contextually appropriate suggestions.
Key changes:
- Created comprehensive Copilot instructions file with 179 lines of repository-specific guidance
- Documented technology stack, coding standards, and common patterns specific to RustIRC
- Included CI/CD guidelines and common pitfalls to avoid
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| - Follow Rust naming conventions (snake_case for functions/variables, CamelCase for types) | ||
| - Use `async/await` with Tokio for all network operations | ||
| - Implement proper trait bounds and lifetime annotations | ||
| - Disable pagers in git commands: `git --no-pager` |
There was a problem hiding this comment.
This Git-specific guidance seems out of place in a "Rust Best Practices" section. Consider moving this to a more appropriate section like "Essential Commands" or creating a separate "Version Control" section.
| - 60 FPS animations in GUI mode | ||
|
|
||
| ## Common Pitfalls to Avoid | ||
| ❌ Running clippy before or parallel to build |
There was a problem hiding this comment.
Unclear guidance: The phrase "parallel to build" is ambiguous. Consider clarifying to "in parallel with the build" or "before the build completes" for better clarity.
| ❌ Running clippy before or parallel to build | |
| ❌ Running clippy before the build completes or in parallel with the build |
doublegate
left a comment
There was a problem hiding this comment.
Reviewed and Approved -- DG 12/10
Pull Request
Description
Configures GitHub Copilot with repository-specific instructions to guide code generation and suggestions according to RustIRC's architecture, coding standards, and best practices.
Related Issue
Fixes #(issue number from problem statement)
Type of Change
Changes Made
.github/copilot-instructions.mdwith 179 lines of repository-specific guidanceTesting
Test Details
Describe the tests you ran to verify your changes:
.github/copilot-instructions.mdfollows GitHub's documented conventionsScreenshots (if applicable)
N/A - Documentation file only
Performance Impact
Security Considerations
Breaking Changes
Checklist
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:
gh.iocurl -s REDACTED(dns block)curl -sL REDACTED(dns block)curl -sIL REDACTED(dns block)If you need me to access, download, or install something from one of these locations, you can either:
Original prompt
✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.
Note
Adds repository-specific Copilot instructions detailing standards, workflows, and guidance for RustIRC.
/.github/copilot-instructions.mdoutlining:Written by Cursor Bugbot for commit 23bb8b3. This will update automatically on new commits. Configure here.