2.3 KiB
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
- En GitHub, crea un repositorio en la cuenta de la organización.
Recomendado: nombre corto, kebab-case, por ejemplo
business-map. - Marca Public.
- No inicialices con README, .gitignore ni licencia (ya vienen en este prototipo).
- 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.mdISSUE_TEMPLATE/feature.mdPULL_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 comoCONTRIBUTING.mden la raíz o enlázalo desde el README.CODE_OF_CONDUCT.mdrecomendado en la raíz (Contributor Covenant oficial).
6. Despliegue gratuito
Opción recomendada: Cloudflare Pages o GitHub Pages.
Para GitHub Pages con Vite:
- Settings → Pages → Build and deployment → Source: GitHub Actions.
- 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). - Ajusta
baseenvite.config.jsal 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.