Repositorios para aprender - OpenVE/filosofia GitHub Wiki

Para motivar a más personas a participar, es necesario crear repositorios para cada lenguaje de programación, con la finalidad de exponer ejemplos de casos útiles o de rutinas (macros, algoritmos) que puedan ser traducidas de un lenguaje a otro.

Idioma

Para mantener las Wikis y los tutoriales, las iremos construyendo primero en Español y luego también en Inglés (recordemos que es el lenguaje más usado internacionalmente). El código fuente, con sus nombres de variables, nombres de archivos y comentarios, deberán estar 100% en inglés.

Estructura

Estos repositorios deben contar con una estructura similar, para que cuando un recién ingresado acceda uno del lenguaje que más sepa, pueda entender cómo recorrer los demás, y así facilitar el aprendizaje.

La estructura de estos repositorios de aprendizaje debe ser la siguiente:

Language/
| README.md
| LICENSE
| Examples/
| | Algorithms/
| | Problems/
| | Tests/
Tutorials/

Toda la documentación y tutoriales deberán ir en la Wiki del repositorio, de esa manera nos organizamos y además mantenemos por fuera el código, para reducir la cantidad de contenido y la posible complejidad de mantener todo actualizado.

Explicación de la Estructura:

  1. /README.md
    Deberá estar la información sobre el repositorio, un párrafo sobre el lenguaje y alguna instrucción básica o enlace para acceder a los documentos de la carpeta /tutorials/Getting\ Started/

  2. /LICENSE
    La licencia de toda la documentación disponible deberá ser CC BY-NC-SA 3.0, sin embargo, cada programa dentro de estos repositorios puede contener su propia licencia, lo cual deberá dejarse expresado en este archivo (/LICENSE). Las licencias individuales de cada programa debe pertenecer a alguna de las indexadas por la Open Source Initiative.

    También es válido quitar este archivo y dejar expresa las licencias dentro del README.

  3. /Examples
    En este directorio estarán todos los archivos de código fuente, separados en directorios internos según el tipo de desarrollo que se está haciendo. Los directorios internos que aparecen en el ejemplo deben existir en algún momento, dado los aportes que se vayan realizando.

  4. /Tutorials
    En este directorio se encontrarán los tutoriales respectivos al lenguaje, separados en directorios internos según la temática principal del tutorial. La carpeta inicial de este directorio se deberá llamar "Getting Started" y su contenido serán los tutoriales básicos para que un estudiante o persona interesada pueda empezar a hacer programas con este lenguaje, a utilizar el repositorio que estamos proveyendo y a contribuir en el mismo.

Evolución del Repositorio

La estructura inicial, tal como fue expresada en los puntos anteriores, debe existir en el repositorio inicial, sin embargo, sus contenidos pueden avanzar según la disponibilidad y experiencia de los contribuyentes.

¡Tu opinión cuenta!

Añade tus inquietudes aquí y ayúdanos a hacer mejores repositorios, wikis y proyectos. Considera la realidad del resto de los participantes y pon la visión de la comunidad por encima de tus deseos y necesidades, mientras más contribuyas y exijas calidad, más podrás aprovechar la labor que hagamos en conjunto.