En 馃 Elixir Chile 馃嚚馃嚤 buscamos aumentar la cantidad de devs que sepan utilizar Elixir. Con el objetivo de brindar m贸dulos de apoyo y de ejemplo, se debe confeccionar artefactos de software de alta calidad, utilizando las herramientas y buenas pr谩cticas que se esperan de un producto que pueda ser usado en ambientes de producci贸n.
Para esto deben cumplir con lo siguiente:
-
Correctamente documentados utilizando HexDocs y Asciidoc cuando HexDocs no sea apropiado.
-
Funciones con especificaci贸n y tipos Typespecs.
-
Seguir buenas pr谩cticas de TDD y tener un buen puntaje de coverage.
-
Utilizar Credo para an谩lisis de c贸digo est谩tico.
-
Seguir las recomendaciones de DDD cuando sea prudente.
-
Utilizar la licencia Mozilla Public License v2.0 para el c贸digo y Creative Commons Atribuci贸n-NoComercial-CompartirIgual 4.0 Internacional (CC BY-NC-SA 4.0) para los artefactos como documentaci贸n, im谩genes u otros.
-
Soportar como m铆nimo, las 煤ltimas dos versiones del lenguaje.
-
Utilizar Romantic Versioning, partiendo desde la version 1.0.0.
-
Utilizar un Changelog.
-
Utilizar un archivo de
.editorconfig. -
Utilizar Trunk Based Development para las ramas. Siendo la rama principal llamada
main. -
Utilizar Conventional Commits al momento de hacer squash and merge del PR (leer traducido). Tambi茅n leer la gu铆a https://www.freecodecamp.org/news/writing-good-commit-messages-a-practical-guide/.
-
Seguir, en lo posible, la filosof铆a Unix.
-
Seguir, de preferencia, la gu铆a de estilo: Compass.
-
Utilizar la menor cantidad de dependencias externas posibles.
-
Utilizar el lenguaje ingl茅s para el c贸digo, commits y documentaci贸n de artefactos de software.
-
Utilizar el namespace elixircl_<app> para el nombre de paquetes en hex y ElixirCL<app> como prefijo de los m贸dulos. Ejemplo: elixircl_rut, ElixirCLRut.
Las licencias utilizadas ser谩n para documentos y para c贸digo fuente.
A menos que se especifique lo contrario, Los documentos que no sean c贸digo estar谩n bajo la Licencia Creative Commons Atribuci贸n-No-Comercial-Compartir-Igual 4.0 Internacional
A menos que se especifique lo contrario, todo el c贸digo fuente est谩 bajo a licencia MPL v2.0 (Mozilla Public License Version 2.0).
Es una licencia que es f谩cil de cumplir. Puedes mezclar la licencia MPL v2.0 con cualquier otra licencia, propietaria u de otra 铆ndole. Siempre y cuando se cumplan las siguientes condiciones:
-
Si no modificas los componentes del artefacto de software, solo deber谩s mostrar un enlace al c贸digo fuente del artefacto, de preferencia en un lugar claramente visible dentro del software, por ejemplo el README o secci贸n de autores.
-
Si modificas los componentes de este artefacto, debes solamente proporcionar libremente tus cambios al artefacto (no al proyecto en su totalidad).
Puedes leer el c贸digo completo ac谩: https://github.com/ElixirCL/code-of-conduct
En resumen:
Creemos en la amabilidad, respeto y buena onda en todos nuestras interacciones tanto online como presenciales. Por favor ser lo m谩s buena onda posible con todos los participantes de la comunidad y fuera de esta.