From 2c944a6d8025ac1f28e57917b5a1f34e384dc69f Mon Sep 17 00:00:00 2001 From: Josantonius Date: Thu, 13 Jul 2023 20:05:08 +0200 Subject: [PATCH] docs: release notes for v2.0.3 and archive --- .github/lang/es-ES/CODE_OF_CONDUCT.md | 139 ----------- .github/lang/es-ES/CONTRIBUTING.md | 319 -------------------------- .github/lang/es-ES/LICENSE | 23 -- .github/lang/es-ES/README.md | 255 -------------------- CHANGELOG.md | 12 + LICENSE | 2 +- README.md | 21 +- 7 files changed, 16 insertions(+), 755 deletions(-) delete mode 100644 .github/lang/es-ES/CODE_OF_CONDUCT.md delete mode 100644 .github/lang/es-ES/CONTRIBUTING.md delete mode 100644 .github/lang/es-ES/LICENSE delete mode 100644 .github/lang/es-ES/README.md diff --git a/.github/lang/es-ES/CODE_OF_CONDUCT.md b/.github/lang/es-ES/CODE_OF_CONDUCT.md deleted file mode 100644 index 0da9594..0000000 --- a/.github/lang/es-ES/CODE_OF_CONDUCT.md +++ /dev/null @@ -1,139 +0,0 @@ - -# Código de conducta convenido para contribuyentes - -- [Nuestro compromiso](#nuestro-compromiso) -- [Nuestros estándares](#nuestros-estándares) -- [Aplicación de las responsabilidades](#aplicación-de-las-responsabilidades) -- [Alcance](#alcance) -- [Aplicación](#aplicación) -- [Guías de Aplicación](#guías-de-aplicación) - - [1. Corrección](#1-corrección) - - [2. Aviso](#2-aviso) - - [3. Expulsión temporal](#3-expulsión-temporal) - - [4. Expulsión permanente](#4-expulsión-permanente) -- [Atribución](#atribución) - ---- - -## Nuestro compromiso - -Nosotros, como miembros, contribuyentes y administradores nos comprometemos a -hacer de la participación en nuestra comunidad una experiencia libre de acoso -para todo el mundo, independientemente de la edad, dimensión corporal, -minusvalía visible o invisible, etnicidad, características sexuales, identidad -y expresión de género, nivel de experiencia, educación, nivel socio-económico, -nacionalidad, apariencia personal, raza, religión, o identidad u orientación -sexual. - -Nos comprometemos a actuar e interactuar de maneras que contribuyan a una -comunidad abierta, acogedora, diversa, inclusiva y sana. - -## Nuestros estándares - -Ejemplos de comportamiento que contribuyen a crear un ambiente positivo para -nuestra comunidad: - -- Demostrar empatía y amabilidad ante otras personas. -- Respeto a diferentes opiniones, puntos de vista y experiencias. -- Dar y aceptar adecuadamente retroalimentación constructiva. -- Aceptar la responsabilidad y disculparse ante quienes se vean afectados. -- Centrarse en lo que sea mejor para la comunidad en general. - -Ejemplos de comportamiento inaceptable: - -- El uso de lenguaje o imágenes sexualizadas. -- Aproximaciones o atenciones sexuales de cualquier tipo. -- Comentarios despectivos (_trolling_), insultantes o derogatorios. -- Ataques personales o políticos. -- El acoso en público o privado. -- Publicar información privada de otras personas sin su permiso explícito. -- Cualquier conducta considerada como inapropiada en un entorno profesional. - -## Aplicación de las responsabilidades - -Los administradores de la comunidad son responsables de aclarar y hacer cumplir -nuestros estándares de comportamiento aceptable y tomarán acciones apropiadas y -correctivas de forma justa en respuesta a cualquier comportamiento que -consideren inapropiado, amenazante, ofensivo o dañino. - -Los administradores de la comunidad tendrán el derecho y la responsabilidad de -eliminar, editar o rechazar comentarios, _commits_, código, ediciones de -páginas de wiki, _issues_ y otras contribuciones que no se alineen con este -Código de Conducta, y comunicarán las razones para sus decisiones de moderación -cuando sea apropiado. - -## Alcance - -Este código de conducta aplica tanto a espacios del proyecto como a espacios -públicos donde un individuo esté en representación del proyecto o comunidad. -Ejemplos de esto incluyen el uso de la cuenta oficial de correo electrónico, -publicaciones a través de las redes sociales oficiales, o presentaciones con -personas designadas en eventos. - -## Aplicación - -Instancias de comportamiento abusivo, acosador o inaceptable de otro modo -podrán ser reportadas a los administradores de la comunidad responsables del -cumplimiento a través de [hola@josantonius.dev](mailto:hola@josantonius.dev). -Todas las quejas serán evaluadas e investigadas de una manera puntual y justa. - -Todos los administradores de la comunidad están obligados a respetar la -privacidad y la seguridad de quienes reporten. - -## Guías de Aplicación - -Los administradores de la comunidad seguirán estas Guías de Impacto en la -Comunidad para determinar las consecuencias de cualquier acción que juzguen -como un incumplimiento de este Código de Conducta: - -### 1. Corrección - -**Impacto en la Comunidad**: El uso de lenguaje inapropiado u otro -comportamiento considerado no profesional o no acogedor en la comunidad. - -**Consecuencia**: Un aviso escrito y privado por parte de los administradores -de la comunidad, proporcionando claridad alrededor de la naturaleza de este -incumplimiento y una explicación de por qué el comportamiento es inaceptable. -Una disculpa pública podría ser solicitada. - -### 2. Aviso - -**Impacto en la Comunidad**: Un incumplimiento causado por un único incidente o -por una cadena de acciones. - -**Consecuencia**: Un aviso con consecuencias por comportamiento prolongado. No -se interactúa con las personas involucradas, incluyendo interacción no -solicitada con quienes se encuentran aplicando el Código de Conducta, por un -periodo especificado de tiempo. Esto incluye evitar las interacciones en -espacios de la comunidad, así como a través de canales externos como las redes -sociales. Incumplir estos términos puede conducir a una expulsión temporal o -permanente. - -### 3. Expulsión temporal - -**Impacto en la Comunidad**: Una serie de incumplimientos de los estándares de -la comunidad, incluyendo comportamiento inapropiado continuo. - -**Consecuencia**: Una expulsión temporal de cualquier forma de interacción o -comunicación pública con la comunidad durante un intervalo de tiempo -especificado. No se permite interactuar de manera pública o privada con las -personas involucradas, incluyendo interacciones no solicitadas con quienes se -encuentran aplicando el Código de Conducta, durante este periodo. Incumplir -estos términos puede conducir a una expulsión permanente. - -### 4. Expulsión permanente - -**Impacto en la Comunidad**: Demostrar un patrón sistemático de incumplimientos -de los estándares de la comunidad, incluyendo conductas inapropiadas -prolongadas en el tiempo, acoso de individuos, o agresiones o menosprecio a -grupos de individuos. - -**Consecuencia**: Una expulsión permanente de cualquier tipo de interacción -pública con la comunidad del proyecto. - -## Atribución - -Este Código de Conducta es una adaptación del -[Contributor Covenant](https://www.contributor-covenant.org/), -versión 2.0 disponible en -. diff --git a/.github/lang/es-ES/CONTRIBUTING.md b/.github/lang/es-ES/CONTRIBUTING.md deleted file mode 100644 index cbd7ede..0000000 --- a/.github/lang/es-ES/CONTRIBUTING.md +++ /dev/null @@ -1,319 +0,0 @@ -# Contribución - -Nos encantaría que contribuyeras a este proyecto y ayudaras a mejorarlo. -Estas son las directrices que nos gustaría que siguieras: - ---- - -- [Código de conducta](#código-de-conducta) -- [Preguntas, problemas o ideas](#preguntas-problemas-o-ideas) -- [Agregar o mejorar algo](#agregar-o-mejorar-algo) -- [Reportar un error](#reportar-un-error) -- [Enviar un _issue_](#enviar-un-issue) -- [Enviar un _pull request_](#enviar-un-pull-request) - - [Después de fusionar tu _pull request_](#después-de-fusionar-tu-pull-request) -- [Reglas de codificación](#reglas-de-codificación) -- [Reglas para escribir _commits_](#reglas-para-escribir-commits) - - [Cabecera del _commit_](#cabecera-del-commit) - - [Tipo](#tipo) - - [Ámbito](#ámbito) - - [Resumen](#resumen) - - [Cuerpo del _commit_](#cuerpo-del-commit) - - [Parte inferior del _commit_](#parte-inferior-del-commit) - ---- - -## Código de conducta - -Ayúdanos a mantener este proyecto accesible e inclusivo. -Por favor, lee y sigue nuestro [código de conducta](CODE_OF_CONDUCT.md). - -## Preguntas, problemas o ideas - -Empieza una [nueva discusión](https://github.com/josantonius/php-mime-type/discussions/new) y selecciona -la categoría adecuada para ello: - -- `General`: Cualquier cosa que sea relevante para el proyecto. -- `Ideas`: Ideas para mejorar el proyecto o proponer nuevas características. -- `Encuestas (polls)`: Encuestas con múltiples opciones para que la comunidad. -- `Q&A`: Preguntas para que la comunidad responda. -- `Mostrar y contar (show and tell)`: Creaciones, experimentos o pruebas. - -## Agregar o mejorar algo - -- Para un **cambio importante**, -abre una [nueva discusión](https://github.com/josantonius/php-mime-type/discussions/new) en la categoría -_`Ideas`_ y expón tu propuesta para que pueda ser discutida. Esto también nos permitirá coordinar -mejor nuestros esfuerzos, evitar la duplicación del trabajo y ayudarte a elaborar el cambio para -que sea para que sea aceptado con éxito en el proyecto. - -- **Pequeñas características** pueden desarrollarse -y [enviar directamente un _pull request_](#enviar-un-pull-request). - -## Reportar un error - -Si encuentras un error en el código, puedes ayudarnos -[enviando un _issue_](#enviar-un-issue) a nuestro -[repositorio](https://github.com/josantonius/php-mime-type). O mejor aún, puedes -[enviar un _pull request_](#enviar-un-pull-request) con una solución. - -## Enviar un _issue_ - -Los reportes de problemas son muy valiosos para cualquier proyecto. - -Los grandes informes de errores suelen tener: - -- Un resumen rápido y/o antecedentes. -- Pasos para reproducir el problema. -- Ser específico. -- Dar un ejemplo de código si se puede. -- Lo que se esperaba que ocurriera. -- Lo que realmente sucede. -- Notas; por qué podría estar sucediendo, pruebas que no funcionaron... - -[Envía un nuevo _issue_](https://github.com/josantonius/php-mime-type/issues/new) para reportar un error. - -## Enviar un _pull request_ - -Los _pull request_ son una gran manera de incluir tus ideas en este proyecto -o simplemente arreglar algo. - -Antes de enviar tu _pull request_ ten en cuenta las siguientes directrices: - -1. Busca en [GitHub](https://github.com/josantonius/php-mime-type/pulls) si existe algún tema relacionado -para asegurarte que no esté repetido. - -1. [Bifurca](https://github.com/josantonius/php-mime-type/fork) el repositorio a tu propia cuenta de GitHub. - -1. Clona el repositorio en tu máquina. - -1. Sitúate en el repositorio clonado. - - ```shell - cd php-mime-type - ``` - -1. Crea una rama a partir de la rama `main` con un nombre corto pero descriptivo. - - ```shell - git checkout -b descriptive-name main - ``` - -1. Realiza tus cambios en la nueva rama, incluyendo las pruebas necesarias. - -1. Sigue nuestras [reglas de codificación](#reglas-de-codificación). - -1. Ejecuta el conjunto de pruebas del repositorio completo. - - ```shell - composer tests - ``` - -1. Confirma tus cambios utilizando un _commit_ descriptivo que siga nuestras - [reglas para escribir _commits_](#reglas-para-escribir-commits). - - ```shell - git commit -a - ``` - - **La opción `-a` agregará (`add`) y eliminará (`rm`) los archivos editados.** - -1. Envía (_push_) tu rama a GitHub: - - ```shell - git push origin descriptive-name - ``` - -1. En GitHub, envía un [_pull request_](https://github.com/josantonius/php-mime-type/compare/main..) -hacia `php-mime-type:main`. - -- Si te sugerimos algún cambio: - - Realiza las actualizaciones necesarias. - - Vuelve a ejecutar las pruebas para asegurarse de que siguen pasando. - - Reorganiza tu rama y envíala a tu repositorio de GitHub (esto actualizará tu _pull request_): - - ```shell - git rebase main -i - git push -f - ``` - -¡Eso es todo! ¡Gracias por tu contribución! - -### Después de fusionar tu _pull request_ - -Después de que tu _pull request_ se fusione, puedes eliminar con seguridad tu rama y actualizar los -cambios desde la rama `main`: - -- Elimina la rama remota en GitHub, ya sea a través de la interfaz de GitHub o de tu _shell_ local: - - ```shell - git push origin --delete descriptive-name - ``` - -- Sitúate en la rama `main`: - - ```shell - git checkout main -f - ``` - -- Elimina la rama local: - - ```shell - git branch -D descriptive-name - ``` - -- Actualiza tu rama _`main`_ con la última versión: - - ```shell - git pull --ff upstream main - ``` - -## Reglas de codificación - -Para garantizar la coherencia en todo el código fuente, ten en cuenta estas reglas mientras trabajas: - -- Todas las características o correcciones de errores **deben ser probadas** por una o más -especificaciones (pruebas unitarias). - - Puedes utilizar el siguiente comando para comprobar las pruebas: - - ```shell - composer phpunit - ``` - -- Toda nueva característica **debe ser documentada** en el archivo `README.md`. - -- Utilizamos `PHP CodeSniffer` y `PHP Mess Detector` para definir nuestros estándares de código. - - Puedes utilizar los siguientes comandos para comprobar el estado de tu código: - - ```shell - composer phpcs - ``` - - ```shell - composer phpmd - ``` - - Puedes utilizar el siguiente comando para formatear automáticamente -los errores encontrados con `PHP CodeSniffer`: - - ```shell - composer fix - ``` - -## Reglas para escribir _commits_ - -Tenemos reglas muy precisas sobre cómo deben ser formateados nuestros _commits_. -Este formato hace que el historial _commits_ sea más fácil de leer. - -Cada _commit_ consta de un **_header_**, un **_body_**, y un **_footer_**. - -```none -
- - - -