Skip to content

Conversation

@fbraz3
Copy link

@fbraz3 fbraz3 commented Sep 10, 2025

Add AI coding agent instructions

This PR adds .github/copilot-instructions.md to streamline the development process by providing AI assistants and new contributors with immediate access to project-critical knowledge.

Development workflow improvements:

  • Faster onboarding: New developers can understand build requirements and coding standards immediately
  • Consistent code quality: AI assistants will follow TheSuperHackers comment format and project conventions
  • Reduced review cycles: Contributors understand VC6 compatibility requirements and testing procedures upfront
  • Better AI assistance: Copilot/Cursor get context about legacy C++98 patterns, GameLogic/GameClient separation
  • Avoid common mistakes: Documents critical aspects like replay compatibility testing and Zero Hour precedence

Key knowledge documented:

  • CMake presets and VC6 build requirements for retail compatibility
  • Mandatory TheSuperHackers comment format and conventional commits
  • Replay testing procedures that prevent breaking retail compatibility
  • Dual game architecture and engine separation patterns

Impact on development:

Instead of learning project specifics through trial/error or lengthy discussions, contributors can immediately understand what makes this project unique and work productively from day one.

- Create comprehensive .github/copilot-instructions.md
- Document dual game architecture (Generals/GeneralsMD)
- Explain CMake presets and VC6 compatibility requirements
- Detail TheSuperHackers comment format and development workflow
- Include replay compatibility testing procedures
- Document build system, dependencies, and key project patterns
@M1SAM18
Copy link

M1SAM18 commented Sep 10, 2025

Having someone to montior the AI would also be necessary to keep up to date with the work that is already done, in order to avoid reopening issues that have already been solved or is being worked on or its already located in another issue elsewhere in issue section.

This must be done in order to avoid waste of time and unnecessary increase of work since whoever has not followed the project and are new could create confusion and slow down the workflow.

That being said If the github AI can keep up to date as to what is currently being worked on and what has been finished in a wiki format that would be great and much appreciated.

Copy link

@xezon xezon left a comment

Choose a reason for hiding this comment

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

I am not using AI agents so I dont know how useful this is but looks like it will not hurt.

@xezon xezon added the Documentation Is documentation or complementary resource label Sep 10, 2025
@xezon xezon changed the title docs: Add AI coding agent instructions for GeneralsGameCode docs: Add AI coding agent instructions Sep 10, 2025
@xezon xezon merged commit 55e6cd4 into TheSuperHackers:main Sep 10, 2025
7 checks passed
@fbraz3 fbraz3 deleted the gh-copilot branch September 10, 2025 13:59
fbraz3 added a commit to fbraz3/GeneralsX that referenced this pull request Nov 10, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Documentation Is documentation or complementary resource

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants