Anatomía de un proyecto

• Las carpetas de proyectos siguen la nomenclarura 00-slug, donde 00 son dos dígitos que expresan una intención de ordenado, y el slug es un string único para cada proyecto, en minúsculas y de entre 1 y 97 caracteres. Expresado como RegExp sería algo como ^\d{2}-[a-z\-]{1,97}$. Longitud máxima del nombre de carpeta son 100 caracteres.
• El único archivo obligatorio es el README.md.
• Todo lo demás se considera boilerplate.

README.md

Lo mejor es ver un par de ejemplos como cipher o burger-queen.

• Debe comenzar con un <h1> con el título del proyecto.
• Justo después del título debe incluir un índice (TOC).
• El índice debería incluir solo un nivel del árbol, a menos de que haya un motivo especial que lo justifique.
• Inmediatamente después cerramos el índice con un <hr />.
• El índice no debe listarse a sí mismo. No hay necesidad de incluir el índice como primer elemento del índice.
• Los elementos del indice estarán numerados. Esto hace más fácil digerir y manejar la información del proyecto.

Ejemplo de título y TOC:

# Título

## Índice

* [1. Preámbulo](#1-preámbulo)
* [2. Resumen del proyecto](#2-resumen-del-proyecto)
* [3. Objetivos de aprendizaje](#3-objetivos-de-aprendizaje)
* [4. Consideraciones generales](#4-consideraciones-generales)
* [5. Criterios de aceptación mínimos del proyecto](#5-criterios-de-aceptación-mínimos-del-proyecto)
* [6. Pistas, tips y lecturas complementarias](#6-pistas-tips-y-lecturas-complementarias)

***

Secciones

Cada sección (obligatoria o no) comienza con un <h2> con el título de la sección. Para facilitar la navegación y conversación sobre los proyectos usamos un prefijo numérico (como lista numerada).

Secciones obligatorias

• 1. Preámbulo
• 2. Resumen del proyecto
• 3. Objetivos de aprendizaje
• 4. Consideraciones generales
• 5. Criterios de aceptación mínimos del proyecto
• 6. Pistas, tips y lecturas complementarias

Ejemplo de secciones:

## 1. Preámbulo

Entre 1 y 3 párrafos dándo contexto al proyecto, las tecnologías y herramientas
involucradas, por qué es importante/útil aprender esto. Qué esperar del proyecto
(desde el punto de vista de la estudiante).

## 2. Resumen del proyecto

Blah blah blah...

## 3. Objetivos de aprendizaje

Se debe listar en forma de checkboxes ej: `[ ] objetivo 1` los OAs disponibles en
este proyecto, estos OAs deben de seguir la nomenclatura y categoría del [repositorio
de OAs](https://docs.google.com/spreadsheets/d/1iMipHxaYhJxTvDysCcfE42P_Wa-sowFqMM2XJbbcEBM/edit#gid=860874863)

Si se desea agregar nuevos OAs, primero deberían de agregarse al repositorio con posterior discusión.

Tópicos: _react_, _angular_, _vue_, _pwa_, _offline-first_, _service-worker_.

## 4. Consideraciones generales

Este proyecto se debe "resolver" de forma [individual/duplas/tríos/...].

Blah blah blah...

## 5. Criterios de aceptación mínimos del proyecto

### Definición del producto

Blah blah blah...

***

#### [Historia de usuario 1] Blah blah blah...

Blah blah blah...

##### Criterios de aceptación

Lo que debe ocurrir para que se satisfagan las necesidades del usuario)

* ...

##### Definición de terminado

Lo acordado que debe ocurrir para decir que la historia está terminada.

* ...

***

## 6. Pistas, tips y lecturas complementarias

### Primeros pasos

Blah blah blah...

### Otros recursos

Blah blah blah...

Secciones opcionales

• Hacker edition
• Consideraciones técnicas (más detalles técnicos 🙈)
• Checklist