✨ Set up Copilot instructions

[Copilot]

• Understand the repository structure and technology stack
• Identify key project details (Python, FastAPI, Frida, GStreamer)
• Create .github directory
• Create copilot-instructions.md file with comprehensive guidelines
• Review and validate the instructions
• Address code review feedback (fix placeholder format and grammar)
• Update instructions to reflect current code organization
• Add references to main README and other documentation

Summary

Created and updated .github/copilot-instructions.md with comprehensive guidelines for GitHub Copilot.

Latest Updates (addressing feedback)

Updated the Copilot instructions to:

1. Reference the main README: Added links to README.md in the overview, important notes, and references sections
2. Reflect current code organization:
   • Documented that the repo has two main components: the main gstaudit app and the girest subproject
   • Clarified that girest is a standalone GIRepository to REST API generator with its own dependencies
   • Noted the different frameworks used (FastAPI for main app, Connexion for girest)
3. Enhanced dependency documentation: Split dependencies section to show both pyproject.toml files
4. Improved architectural notes: Better explained why PyGObject isn't used and FastAPI's limitations with references to the README
5. Added more references: Included OpenAPI to TypeScript and Connexion documentation links

The instructions now accurately represent the dual nature of the project and provide clear references to other documentation.

Original prompt

---

This section details on the original issue you should resolve

<issue_title>✨ Set up Copilot instructions</issue_title>
<issue_description>Configure instructions for this repository as documented in Best practices for Copilot coding agent in your repository.

</issue_description>

Comments on the Issue (you are @copilot in this section)

Fixes #3

---

💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.

[turran]

@copilot with the current organization of the code, can you update the instructions? Also, can the instructions reference other READMEs?

[Copilot]

@copilot with the current organization of the code, can you update the instructions? Also, can the instructions reference other READMEs?

Updated the instructions in commit 57219d to reflect the current code organization with:

• References to the main README throughout (overview, important notes, and references sections)
• Clear documentation of the two-component structure (main gstaudit app and girest subproject)
• Separate dependency sections for both pyproject.toml files
• Notes on the different frameworks used (FastAPI vs Connexion)
• Links to README sections explaining architectural decisions