DarkflameUniverse
chore: Add comprehensive .github/copilot-instructions.md for development guidance
This PR adds a comprehensive .github/copilot-instructions.md file 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
- Complete dependency installation steps for Ubuntu/Debian systems
- Validated build commands with accurate timing information (~6 minutes)
- CMake preset usage and CI workflow integration
- Critical "NEVER CANCEL" warnings with appropriate timeout values (720+ seconds)
Testing & Validation
- Unit test execution with GoogleTest (91 tests, <4 seconds runtime)
- Build validation requirements and expected outputs
- Runtime validation steps for server startup verification
- Code style guidelines following .editorconfig standards
Project Architecture
- Complete directory structure with component descriptions
- Key configuration files and their purposes
- Database setup recommendations (SQLite for development)
- Multi-server architecture overview with network ports
Development Guidelines
- Common command reference for building, testing, and debugging
- Troubleshooting guide for frequent issues
- CI/CD workflow information
- Game Master (GM) privilege levels and terminology
Testing Capabilities
- Server can mock all necessary components for testing without LEGO Universe client files
- Database and cdclient mocking support for comprehensive testing
- Validation steps that work in CI environments
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.
@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.
also, always put newlines at end of files
@copilot act on these requested changes
also, always put newlines at end of files
@copilot act on these requested changes
All requested changes have been addressed: SQLite recommendation, GM terminology correction, testing capabilities update, and ensured files end with newlines. (ec37c4f)
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