Skip to content

Conversation

Copy link
Contributor

Copilot AI commented Oct 19, 2025

Overview

This PR adds comprehensive GitHub Copilot instructions to help the AI coding assistant provide more accurate and context-aware code suggestions for the AgileGamifAI repository.

What's Changed

Created .github/copilot-instructions.md with detailed guidelines covering all aspects of the project, including:

📚 Project Context

  • Clear description of AgileGamifAI as an interactive platform for Agile team games
  • Complete technology stack documentation (React 19+, TypeScript, Vite 7+, Tailwind CSS 4+, Jest, Supabase, Netlify Functions)
  • Project structure and file organization

💻 Code Standards

  • TypeScript: Strict typing guidelines, interface definitions, and React 19+ type usage
  • React Components: Functional components with hooks, proper prop types, and composition patterns
  • Styling: Tailwind CSS utility classes, design system colors (Teal/Purple), mobile-responsive requirements
  • Accessibility: WCAG 2.1 AA compliance standards

🔒 Security Guidelines (Critical)

Emphasized the project's critical security consideration:

  • Environment variables prefixed with VITE_ are exposed in client bundles
  • Clear API key handling practices and security checklist for all changes
  • Preference for serverless functions (Netlify Functions) to protect API keys
  • References to existing SECURITY.md documentation

🧪 Development Workflow

  • Setup instructions with note about --legacy-peer-deps requirement (React 19 compatibility)
  • Complete testing commands and patterns using Jest and React Testing Library
  • Linting and type checking procedures
  • Build and preview commands
  • Local development with serverless functions

🤖 AI Features Integration

  • Guidelines for LLM service integration through secure serverless functions
  • Error handling and fallback behavior requirements
  • Input validation and sanitization practices

📋 Additional Guidelines

  • Code quality requirements and ESLint configuration
  • Performance targets (Lighthouse 95+ score)
  • Browser support specifications
  • Common code patterns with examples
  • Agile framework-specific notes (Scrum, Kanban, XP, Lean, LeSS, Nexus)

Benefits

With these instructions, GitHub Copilot will:

  • Generate code that matches the project's TypeScript and React patterns
  • Follow security best practices for API key handling
  • Write tests consistent with existing Jest/React Testing Library patterns
  • Maintain proper styling with Tailwind CSS
  • Ensure accessibility compliance
  • Provide more accurate suggestions based on project context

References

Closes #[issue_number]

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 #105


💡 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.

@lorettarehm lorettarehm marked this pull request as ready for review October 19, 2025 18:54
Copilot AI changed the title [WIP] Set up Copilot instructions for repository ✨ Set up comprehensive Copilot instructions for AgileGamifAI Oct 19, 2025
Copilot AI requested a review from lorettarehm October 19, 2025 18:57
Copilot finished work on behalf of lorettarehm October 19, 2025 18:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

✨ Set up Copilot instructions

2 participants