Skip to content

Commit e5651ac

Browse files
committed
docs: improve README for template usage and add CHANGELOG
1 parent 8af9d7d commit e5651ac

2 files changed

Lines changed: 92 additions & 10 deletions

File tree

.github/CHANGELOG.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# Changelog
2+
3+
Todos los cambios notables en este template serán documentados aquí.
4+
5+
El formato está basado en [Keep a Changelog](https://keepachangelog.com/es-ES/1.0.0/),
6+
y este proyecto adhiere a [Versionado Semántico](https://semver.org/lang/es/).
7+
8+
## [1.0.0] - 2026-01-17
9+
10+
### Añadido
11+
12+
- Configuración inicial del template
13+
- `copilot-instructions.md` con reglas estrictas para IA
14+
- `backend-guidelines.md` con guías de arquitectura y seguridad
15+
- Skills: error-handling, logging y performance
16+
- `dependabot.yml` para actualización automática
17+
- `meta.md` con prioridades y uso
18+
- `.gitignore` básico
19+
- README con instrucciones de uso y actualización
20+
21+
### Removido
22+
23+
- Workflow CI del template (solo para proyectos que lo usen)
24+
25+
[1.0.0]: https://github.com/benser22/github-backend-template/releases/tag/v1.0.0

.github/README.md

Lines changed: 67 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,75 @@
1-
# .github Backend Kit
1+
# 🚀 GitHub Backend Template
22

3-
Contenido: automatización GH Actions, instrucciones para Copilot y guías de arquitectura/seguridad backend.
3+
[![Template](https://img.shields.io/badge/Template-Ready-brightgreen)](https://github.com/benser22/github-backend-template)
4+
[![Version](https://img.shields.io/badge/Version-1.0.0-blue)](https://github.com/benser22/github-backend-template/releases)
45

5-
## Estructura
6+
Template con configuraciones de GitHub Actions, instrucciones de Copilot y guías de backend para nuevos proyectos.
67

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?
109

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
1216

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
1572

1673
---
1774

18-
Objetivo: consistencia, performance y seguridad mínima por defecto.
75+
**Objetivo**: Consistencia, performance y seguridad mínima por defecto.

0 commit comments

Comments
 (0)