Este es un libro libre y, como tal, está abierto a contribuciones de todo el mundo. Sin embargo, esas contribuciones tienen que ser revisadas y aceptadas por una persona humana; por eso hago estas reglas, para que sea más fácil que se revisen y eventualmente se acepten. Todas las contribuciones serán reconocidas en el prólogo y en las siguientes ediciones del libro tanto físico como electrónico.
Por favor, trata de seguir las siguientes reglas.
-
Cada pull request debe incluir un solo cambio en un solo commit. Si hay varios, unos aceptables y otros no, la discusión puede bloquear el que se acepte todo el bloque, aparte de que cuesta más trabajo hacer la revisión de varios a la vez. Como GitHub va añadiendo al pull request todos los commits que se hagan a continuación del primero, es mejor que hagas ramas diferentes para cada cambio y solicites la incorporación de ese cambio desde la rama correspondiente.
-
Si el cambio incluye palabras nuevas y al incorporarlo no pasa la integración continua, comprueba de qué palabra se trata y añádela al fichero
txt/words.dic. Si es un error ortográfico, lo mejor es corregirlo. -
Si son errores ortográficos, gramaticales o de código, se aceptarán sin problemas y con agradecimiento eterno. Si son añadidos, nuevo material tal como ejemplos nuevos, es mejor que abras un issue para discutirlo previamente.
-
Este libro, como todos, tiene su estilo. En particular, ese estilo incluye que los títulos de las secciones sean parte de una frase, por lo que podrán estar en mayúsculas o minúsculas, tener puntos o comas al final. No es un error que los títulos estén en minúsculas, es un feature. También bromas, comentarios sobre Python u otros lenguajes, elección de nombres de variables y cualquier otra peculiaridad con la que podrás de estar de acuerdo o no, pero que es parte de ese estilo. En general, no se aceptarán cambios sobre este tipo de cosas terriblemente subjetivas; pero es un libro libre, haz un fork y cambia lo que estimes conveniente.
-
En caso de duda, abre un issue.