taller-repos-readmes
Una discusión sobre consejos, tips, templates y políticas para estructurar repositorios y escribir buenos readmes.
Indice
- Temas de la presentación
- Otros temas interesantes no cubiertos
- Herramientas usadas en la presentación
- Duración recomendada
- Fuentes utilizadas
Temas de la presentación
- Secciones de un README
- Ejemplos de buenos READMEs
- Tips de buenos READMEs
- Readme Driven Development
Otros temas interesantes no cubiertos
- CONTRIBUTING.md
- Wikis en Github
- Read The Docs
- Jekyll
- LICENSE
Herramientas usadas en la presentación
- Cleaver: 30-sec slideshows for Hackers. Se escribe en Markdown y renderiza en html.
Duración recomendada
1 hora y media / 2 horas
Fuentes utilizadas
- Formatting your README
- A curated list of awesome READMEs
- How To Write A Readme
- Readme Driven Development ES GENIAL!
- Project Template como ejemplo de un template para proyectos de apertura de datasets
- Tipos de repos de Sunlight
TODOs
- Completar la parte de la presentación sobre repos
- Agregar algo sobre versionado (HISTORY.md) y tags para releases