Files
localesp/docs/06-github-setup.md
2026-05-20 14:05:55 +02:00

2.3 KiB

Configuración del repositorio en GitHub

Pasos para dejar listo el repositorio. Pensado para que lo hagas una sola vez.

1. Crear el repositorio

  1. En GitHub, crea un repositorio en la cuenta de la organización. Recomendado: nombre corto, kebab-case, por ejemplo business-map.
  2. Marca Public.
  3. No inicialices con README, .gitignore ni licencia (ya vienen en este prototipo).
  4. Sube el código:
    git init
    git add .
    git commit -m "Prototipo inicial"
    git branch -M main
    git remote add origin git@github.com:ORG/business-map.git
    git push -u origin main
    

2. Ajustes básicos (Settings → General)

  • Features: deja activos Issues y Discussions. Desactiva Wikis y Projects hasta que se usen.
  • Pull Requests: marca "Allow squash merging" como única opción y "Always suggest updating pull request branches".
  • Archive: deja desactivado.

3. Protección de la rama main (Settings → Branches)

Añade una regla para main:

  • Require a pull request before merging.
  • Require approvals: 1.
  • Dismiss stale approvals when new commits are pushed.
  • Do not allow bypassing the above settings.

4. Plantillas

Las plantillas ya están en .github/ del prototipo:

  • ISSUE_TEMPLATE/bug.md
  • ISSUE_TEMPLATE/feature.md
  • PULL_REQUEST_TEMPLATE.md

5. Documentos visibles en GitHub

Para que GitHub los muestre como insignias del repositorio:

  • README.md (raíz).
  • LICENSE (raíz).
  • docs/05-contributing.md: súbelo además como CONTRIBUTING.md en la raíz o enlázalo desde el README.
  • CODE_OF_CONDUCT.md recomendado en la raíz (Contributor Covenant oficial).

6. Despliegue gratuito

Opción recomendada: Cloudflare Pages o GitHub Pages.

Para GitHub Pages con Vite:

  1. Settings → Pages → Build and deployment → Source: GitHub Actions.
  2. Añade un workflow en .github/workflows/deploy.yml (no incluido en el prototipo para mantenerlo mínimo; añadirlo cuando se decida la URL final).
  3. Ajusta base en vite.config.js al path del repo.

7. Etiquetas iniciales sugeridas

Crea en Issues → Labels:

  • good first issue (verde)
  • bug (rojo)
  • enhancement (azul)
  • documentation (gris)
  • discussion (morado)

8. Discussions

Activa Discussions con las categorías: Announcements, Ideas, Q&A. Sirven como foro de baja fricción para la comunidad.