|
1 | | -# .github Backend Kit |
| 1 | +# 🚀 GitHub Backend Template |
2 | 2 |
|
3 | | -Contenido: automatización GH Actions, instrucciones para Copilot y guías de arquitectura/seguridad backend. |
| 3 | +[](https://github.com/benser22/github-backend-template) |
| 4 | +[](https://github.com/benser22/github-backend-template/releases) |
4 | 5 |
|
5 | | -## Estructura |
| 6 | +Template con configuraciones de GitHub Actions, instrucciones de Copilot y guías de backend para nuevos proyectos. |
6 | 7 |
|
7 | | -- `workflows/`: CI (Lint, Test, Build). |
8 | | -- `skills/`: Reglas detalladas de Logging, Errores y Performance. |
9 | | -- `copilot-instructions.md`: Reglas estrictas para el agente de IA. |
| 8 | +## 📋 ¿Qué incluye? |
10 | 9 |
|
11 | | -## Uso rápido |
| 10 | +- **`copilot-instructions.md`**: Reglas estrictas para el agente de IA |
| 11 | +- **`skills/`**: Guías detalladas de Logging, Errores y Performance |
| 12 | +- **`backend-guidelines.md`**: Arquitectura y seguridad backend |
| 13 | +- **`dependabot.yml`**: Actualización automática de dependencias |
| 14 | +- **`workflows/`**: Workflows de CI (para copiar a proyectos) |
| 15 | +- **`meta.md`**: Prioridades y uso de estos archivos |
12 | 16 |
|
13 | | -1. Copiar `.github/` al root del nuevo proyecto. |
14 | | -2. Revisar `meta.md` para prioridades. |
| 17 | +## 🎯 Uso |
| 18 | + |
| 19 | +### Opción 1: Usar como template (Recomendado) |
| 20 | + |
| 21 | +1. Click en **"Use this template"** → **"Create a new repository"** |
| 22 | +2. La carpeta `.github` se creará automáticamente en tu nuevo repo |
| 23 | +3. Personaliza según las necesidades de tu proyecto |
| 24 | + |
| 25 | +### Opción 2: Copiar manualmente |
| 26 | + |
| 27 | +```bash |
| 28 | +cd tu-proyecto |
| 29 | +git clone https://github.com/benser22/github-backend-template.git temp |
| 30 | +cp -r temp/.github . |
| 31 | +rm -rf temp |
| 32 | +``` |
| 33 | + |
| 34 | +## 🔄 Mantener actualizado |
| 35 | + |
| 36 | +### Agregar template como remote |
| 37 | + |
| 38 | +```bash |
| 39 | +git remote add template https://github.com/benser22/github-backend-template.git |
| 40 | +git fetch template |
| 41 | +``` |
| 42 | + |
| 43 | +### Actualizar desde el template |
| 44 | + |
| 45 | +```bash |
| 46 | +git fetch template |
| 47 | +git merge template/main --allow-unrelated-histories |
| 48 | +# Resolver conflictos si es necesario |
| 49 | +``` |
| 50 | + |
| 51 | +### Sincronización selectiva |
| 52 | + |
| 53 | +```bash |
| 54 | +# Solo actualizar un archivo específico |
| 55 | +git checkout template/main -- .github/copilot-instructions.md |
| 56 | +``` |
| 57 | + |
| 58 | +## 📦 Versionado |
| 59 | + |
| 60 | +- Ver [CHANGELOG.md](CHANGELOG.md) para historial de cambios |
| 61 | +- Releases con tags semánticos: `v1.0.0`, `v1.1.0`, etc. |
| 62 | +- Consulta la versión actual en el badge superior |
| 63 | + |
| 64 | +## 🎨 Personalización |
| 65 | + |
| 66 | +Después de usar el template: |
| 67 | + |
| 68 | +1. Revisa `meta.md` para entender prioridades |
| 69 | +2. Personaliza `copilot-instructions.md` según tu stack |
| 70 | +3. Agrega workflows específicos en `workflows/` |
| 71 | +4. Actualiza `dependabot.yml` según tu gestor de paquetes |
15 | 72 |
|
16 | 73 | --- |
17 | 74 |
|
18 | | -Objetivo: consistencia, performance y seguridad mínima por defecto. |
| 75 | +**Objetivo**: Consistencia, performance y seguridad mínima por defecto. |
0 commit comments