-
Notifications
You must be signed in to change notification settings - Fork 180
chore: Add comprehensive .github/copilot-instructions.md for development guidance #1867
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
|
@aronwk-aaron 👋 This repository doesn't have Copilot instructions. With Copilot instructions, I can understand the repository better, work faster and produce higher quality PRs. I can generate a .github/copilot-instructions.md file for you automatically. Click here to open a pre-filled issue and assign it to me. I'll write the instructions, and then tag you for review. |
…ands and timing Co-authored-by: aronwk-aaron <[email protected]>
aronwk-aaron
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
also, always put newlines at end of files
@copilot act on these requested changes |
…bilities, and file endings Co-authored-by: aronwk-aaron <[email protected]>
|
not going to merge without approval from someone else, this is just to help give copilot a baseline when it works on stuff, from what I understand |
| ctest --output-on-failure | ||
| ``` | ||
| - **Test time: <4 seconds. Set timeout to 30+ seconds.** | ||
| - **91 tests run, all should pass** |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This seems brittle for if someone adds more tests.
| ### Runtime Validation | ||
| The servers can be started for basic validation: | ||
| ```bash | ||
| cd build | ||
| ./MasterServer | ||
| ``` | ||
| - **Server will start but complain about missing client files (this is expected)** | ||
| - **Database connections work with proper configuration in sharedconfig.ini** | ||
| - **For full server testing, LEGO Universe client files are required (not available in this repository)** |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What is the point of this without any client files? no world servers can start and thats 90% of the codebase
| cmake -DCMAKE_BUILD_TYPE="Release" .. | ||
| cmake --build . --config Release -j2 | ||
| ``` | ||
| - **Same timing: ~6 minutes. NEVER CANCEL. Set timeout to 720+ seconds.** |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
never cancel but also cancel after 12 minutes, what?
This PR adds a comprehensive
.github/copilot-instructions.mdfile that provides GitHub Copilot coding agents with detailed instructions for working effectively in the DarkflameServer codebase.What's included
The instructions cover all essential aspects of development workflow:
Build Process
Testing & Validation
Project Architecture
Development Guidelines
Testing Capabilities
This documentation enables Copilot agents to work more effectively by understanding the project's build system, testing requirements, and development conventions without requiring external research or trial-and-error approaches.
✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.