[WIP] ✨ Set up Copilot instructions

[Copilot]

GitHub Copilot Instructions for opensource-mieweb Repository

Created comprehensive instructions for GitHub Copilot to work effectively in this Proxmox-based container hosting infrastructure repository.

Progress Checklist:

• Repository Exploration

  • Analyzed main repository structure and all 11 top-level directories
  • Explored submodules: LDAP/LDAPServer, LDAP/pown, ci-cd automation/Proxmox-Launchpad
  • Identified technology stack: Node.js, Bash scripts, Terraform, Docker
  • Located all package.json files and build configurations

• Build System Analysis

  • Verified Node.js applications can build successfully:
    • Wazuh/ component (0.7 seconds)
    • LDAP/LDAPServer/src component (11.9 seconds)
  • Confirmed all shell scripts pass syntax validation
  • Initialized and tested git submodules (30 seconds)

• Validation Scenarios

  • Created comprehensive validation test script (/tmp/validate-instructions.sh)
  • Defined manual validation steps for infrastructure changes
  • Documented expected behaviors for external service dependencies
  • Validated that Node.js apps start properly (with expected config errors)

• Create Instructions File

  • Created .github/copilot-instructions.md with imperative tone
  • Included exact build commands with proper timeout warnings (NEVER CANCEL)
  • Documented validation workflows and expected timings
  • Added comprehensive troubleshooting section
  • Listed what should NOT be attempted in sandbox environments

• Validation Testing

  • EXHAUSTIVELY TESTED: Every command in instructions validated to work correctly
  • Verified timeout values are appropriate for all operations
  • COMPREHENSIVE END-TO-END VALIDATION: All 7 test categories pass
  • Confirmed instructions work exactly as documented

Validation Results (ALL PASS ✅):

1. Repository Structure: All 7 core directories present
2. Git Submodules: All 3 submodules properly initialized
3. Node.js Builds: Wazuh and LDAPServer dependencies installed successfully
4. Shell Script Syntax: All .sh files pass bash -n validation
5. JavaScript Syntax: All .js files pass node -c validation
6. Application Startup: Both Node.js apps start with expected config errors
7. Instructions File: 162-line comprehensive guide created

Key Features of Instructions:

• NEVER CANCEL warnings with specific timeout values (30-60+ seconds)
• Imperative tone: "Run this", "Do not do that" as requested
• Exact build times measured: 12s for LDAPServer, <1s for Wazuh, 30s for submodules
• Manual validation scenarios for infrastructure changes
• Comprehensive troubleshooting for common issues
• Clear DO NOT attempt section for operations requiring external infrastructure
• Technology stack documentation with version requirements
• Reference to key configuration files and scripts

The instructions enable GitHub Copilot to work effectively with this complex infrastructure repository while avoiding commands that require Proxmox, LDAP servers, or AWS credentials.

Fixes #21.

---

💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.