IEEE CS UNAP — Workshop Git & GitHub

Proyecto colaborativo del taller de Git & GitHub de la IEEE Computer Society UNAP. Cada participante agrega su perfil mediante una Pull Request.

🌐 Ver la página web

---

Flujo del repositorio

Fork → Rama → Crear tu JSON → Commit → Push → Pull Request → ✅ Auto-validación → 🎉 Merge

flowchart TD
    A[🍴 Fork del repo] --> B[🌿 Crear rama]
    B --> C[📝 Crear contributors/tu-nickname.json]
    C --> D[💾 Commit + Push]
    D --> E[🔄 Abrir Pull Request]
    E --> F[🤖 GitHub Actions valida]
    F --> G{¿JSON válido?}
    G -->|❌ No| H[Corregir errores → D]
    G -->|✅ Sí| I[🏗️ Regenerar public/index.json]
    I --> J[🎉 Merge automático]

Loading

---

Cómo contribuir

1. Preparar entorno

# Opción A: GitHub Codespace (recomendado — sin instalaciones)
# "Code" → "Codespaces" → "Create codespace on main"

# Opción B: Local
git clone https://github.com/TU-USUARIO/IEEE-CS-UNAP-Workshop.git
cd IEEE-CS-UNAP-Workshop

2. Crear tu rama

git checkout -b feat/add-tu-nickname

3. Crear tu archivo JSON

Crea contributors/tu-nickname.json con esta estructura:

{
  "name": "Tu Nombre",
  "nickname": "tu-nickname",
  "github": "https://github.com/tu-usuario",
  "linkedin": "https://linkedin.com/in/tu-perfil",
  "instagram": "https://instagram.com/tu-usuario",
  "image": "https://github.com/tu-usuario.png",
  "description": "Descripción breve sobre ti",
  "hobbies": ["Hobby 1", "Hobby 2", "Hobby 3"]
}

También puedes usar el formulario en la web para generar el JSON automáticamente.

4. Commit y Push

git add contributors/tu-nickname.json
git commit -m "feat: add profile for tu-nickname"
git push origin feat/add-tu-nickname

5. Crear Pull Request

Ve a GitHub → aparecerá el banner "Compare & pull request" → click → "Create pull request".

---

Automatización (GitHub Actions)

Workflow	Cuándo	Qué hace
Validate PR	Al abrir/actualizar la PR	Verifica que solo se modifique contributors/ y que el JSON sea válido
Generate Contributors	Al hacer merge a main	Regenera public/index.json con todos los perfiles

Si la validación falla, el bot deja un comentario en la PR con el error.

---

Reglas

✅ Solo debes tocar: contributors/tu-nickname.json

❌ No tocar:

• public/index.json (auto-generado)
• Archivos de otros colaboradores
• HTML, CSS, JS del proyecto

---

Agradecimientos

• IEEE Computer Society UNAP Student Branch — organización del taller
• GitHub Education — herramientas para el aprendizaje