From c622efef8d66675196b8ae68abed6b162c185910 Mon Sep 17 00:00:00 2001 From: Grisuno Date: Mon, 24 Jun 2024 05:08:24 -0400 Subject: [PATCH] Create CONTRIBUTING.md --- CONTRIBUTING.md | 64 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 64 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..f9aaf69 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,64 @@ +# Contribuir a LazyOwnInfiniteStorage + +¡Gracias por tu interés en contribuir a LazyOwnInfiniteStorage! A continuación, encontrarás las pautas para contribuir al proyecto. + +## Cómo contribuir + +### Reportar problemas + +Si encuentras un error o tienes una sugerencia para mejorar el proyecto, por favor abre un issue en GitHub. Incluye una descripción detallada del problema o la sugerencia, y proporciona toda la información necesaria para que podamos reproducir el problema o entender mejor la sugerencia. + +### Solicitudes de extracción (Pull Requests) + +Las contribuciones son bienvenidas en forma de pull requests. Aquí hay algunas pautas para asegurarte de que tu contribución se pueda integrar sin problemas: + +1. **Haz un fork del repositorio** y clona tu fork localmente. + + ```sh + git clone https://github.com/tu-usuario/LazyOwnInfiniteStorage.git + cd LazyOwnInfiniteStorage + ``` + +2. **Crea una rama para tu contribución**. Utiliza un nombre descriptivo para tu rama. + + ```sh + git checkout -b nombre-de-tu-rama + ``` + +3. **Realiza tus cambios**. Asegúrate de que tu código siga el estilo del proyecto y que hayas añadido las pruebas necesarias. + +4. **Haz commit de tus cambios**. Asegúrate de escribir un mensaje de commit claro y descriptivo. + + ```sh + git commit -m "Descripción clara de los cambios" + ``` + +5. **Empuja tus cambios a tu fork**. + + ```sh + git push origin nombre-de-tu-rama + ``` + +6. **Abre un pull request**. Ve al repositorio original en GitHub y abre un pull request desde tu fork. Describe los cambios que has realizado y por qué son útiles. + +### Estilo de código + +Mantén un estilo de código consistente con el resto del proyecto. Esto incluye: + +- Seguir las convenciones de nombrado y estilo del proyecto. +- Asegurarte de que tu código está correctamente indentado y formateado. +- Añadir comentarios donde sea necesario para explicar la lógica de tu código. + +### Pruebas + +Asegúrate de que tu código ha sido probado adecuadamente. Si añades nuevas funcionalidades, también debes añadir pruebas para ellas. Si corriges un error, añade una prueba que demuestre la corrección. + +## Comunicación + +Si tienes alguna pregunta o necesitas discutir algo, abre un issue en GitHub o contacta a través de Discord. Estamos aquí para ayudarte y colaborar. + +--- + +Gracias por contribuir a LazyOwnInfiniteStorage. ¡Tus esfuerzos son muy apreciados! + +Creado por [grisuno](https://github.com/grisuno)