Contexto y personalización

Custom Instructions y prompt files reutilizables

GitHub Copilot permite personalizar su comportamiento mediante instrucciones específicas que se aplican automáticamente a todas las interacciones dentro de un proyecto. Esta funcionalidad resulta especialmente valiosa para equipos que necesitan mantener consistencia en el código generado y para proyectos con requisitos específicos de estilo o arquitectura.

Configuración de Custom Instructions

Las Custom Instructions se definen mediante un archivo especial ubicado en .github/copilot-instructions.md en la raíz del proyecto. Este archivo actúa como un contexto permanente que Copilot considera en cada sugerencia o respuesta que genera.

# Instrucciones para GitHub Copilot

## Estilo de código
- Utiliza TypeScript estricto con tipos explícitos
- Prefiere const sobre let cuando sea posible
- Usa nombres descriptivos para variables y funciones
- Implementa manejo de errores con try-catch

## Arquitectura del proyecto
- Sigue el patrón MVC para la estructura de carpetas
- Utiliza inyección de dependencias para servicios
- Implementa interfaces para todos los contratos públicos
- Separa la lógica de negocio de la presentación

## Convenciones específicas
- Los componentes React deben usar hooks funcionales
- Implementa validación de props con PropTypes
- Usa async/await en lugar de Promises encadenadas
- Prefiere composición sobre herencia

El archivo debe escribirse en formato Markdown y puede incluir secciones específicas según las necesidades del proyecto. Copilot procesará estas instrucciones automáticamente cuando genere código o responda preguntas dentro del workspace.

Creación de Prompt Files reutilizables

Los prompt files permiten crear plantillas de consultas reutilizables que el equipo puede utilizar de forma consistente. Estos archivos se almacenan en la carpeta .github/prompts/ y pueden invocarse mediante el comando @workspace en Copilot Chat.

Estructura básica de un prompt file:

---
title: Crear componente React
description: Genera un componente React funcional con TypeScript
---

Crea un componente React funcional que:
- Use TypeScript con tipos explícitos
- Implemente props interface
- Incluya manejo de estados con useState
- Tenga documentación JSDoc
- Siga las convenciones del proyecto

Nombre del componente: {{component_name}}
Props requeridas: {{props_list}}

Ejemplo de prompt file para testing:

---
title: Generar tests unitarios
description: Crea tests completos para funciones y componentes
---

Genera tests unitarios usando Jest y React Testing Library que incluyan:
- Tests de renderizado básico
- Tests de interacción con eventos
- Tests de props y estados
- Mocks para dependencias externas
- Casos edge y manejo de errores

Archivo a testear: {{file_path}}
Funcionalidades específicas: {{features}}

Organización de prompts por categorías

La carpeta .github/prompts/ puede organizarse en subcarpetas temáticas para facilitar la gestión y localización de prompts específicos:

.github/prompts/
├── components/
│   ├── react-component.md
│   ├── form-component.md
│   └── modal-component.md
├── testing/
│   ├── unit-tests.md
│   ├── integration-tests.md
│   └── e2e-tests.md
├── api/
│   ├── rest-endpoint.md
│   ├── graphql-resolver.md
│   └── middleware.md
└── documentation/
    ├── readme-section.md
    ├── api-docs.md
    └── changelog-entry.md

Uso de variables en prompt files

Los prompt files admiten variables dinámicas que se pueden sustituir durante la ejecución. Estas variables se definen usando la sintaxis {{variable_name}} y permiten crear prompts flexibles y reutilizables.

---
title: Crear servicio de API
description: Genera un servicio para consumir APIs REST
---

Crea un servicio TypeScript para la API {{api_name}} que:
- Implemente métodos CRUD básicos
- Use axios para las peticiones HTTP
- Incluya manejo de errores personalizado
- Tenga tipos TypeScript para requests/responses
- Implemente retry logic para fallos de red

Base URL: {{base_url}}
Endpoints requeridos: {{endpoints}}
Autenticación: {{auth_type}}

Mejores prácticas para instructions efectivas

Las instrucciones efectivas deben ser específicas, claras y orientadas a resultados concretos. Evita instrucciones demasiado genéricas que puedan interpretarse de múltiples formas.

Instrucciones específicas por tecnología:

## Framework específico - Next.js
- Usa App Router en lugar de Pages Router
- Implementa Server Components cuando sea posible
- Utiliza dynamic imports para code splitting
- Configura metadata para SEO en cada página

## Base de datos - Prisma
- Define modelos con relaciones explícitas
- Usa transacciones para operaciones complejas
- Implementa soft deletes con campos deletedAt
- Incluye índices para consultas frecuentes

Configuración de contexto por equipo:

## Estándares del equipo
- Commits en inglés siguiendo Conventional Commits
- Pull requests requieren al menos 2 revisiones
- Cobertura de tests mínima del 80%
- Documentación obligatoria para APIs públicas

## Herramientas del proyecto
- ESLint con configuración personalizada
- Prettier para formateo automático
- Husky para pre-commit hooks
- Jest para testing unitario

La efectividad de las instrucciones mejora cuando se combinan reglas generales con ejemplos específicos que ilustren el comportamiento esperado. Esto ayuda a Copilot a generar código más alineado con las expectativas del proyecto y reduce la necesidad de correcciones manuales posteriores.