Skip to content

Commit 6bf466f

Browse files
committed
docs: se actualiza README y LICENCIA
1 parent 7da5163 commit 6bf466f

2 files changed

Lines changed: 56 additions & 2 deletions

File tree

CONTRIBUTING.md

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
# **Guía de Contribución**
2+
3+
¡Hola! Primero que nada, gracias por tomarte el tiempo de visitar este proyecto.
4+
5+
**javatest** nació como un espacio para dominar el desarrollo robusto en Java mediante pruebas unitarias y código limpio. Creemos que la mejor forma de aprender es colaborando, por lo que cualquier mejora, por pequeña que sea (incluso corregir un error ortográfico en la documentación), es sumamente valiosa.
6+
7+
> "El buen código no se escribe a la primera, se refina en comunidad."
8+
9+
---
10+
11+
### **Cómo empezar**
12+
No necesitas ser un experto para contribuir. Aquí tienes algunas ideas:
13+
1. **Reportar Errores:** Si encuentras un bug, por favor abre un *Issue* describiendo el problema, los pasos para reproducirlo y el comportamiento esperado.
14+
2. **Sugerir Funcionalidades:** Las nuevas ideas son bienvenidas. Abre un *Issue* para discutir la propuesta antes de empezar a programar.
15+
3. **Añadir nuevos tests:** ¿Crees que nos faltó algún caso extremo en `DateUtil` o `FizzBuzz`? ¡Añádelo!
16+
4. **Mejorar algoritmos:** Si ves una forma más eficiente o legible de resolver un problema, cuéntanosla.
17+
5. **Documentación:** Ayúdanos a que el README o los comentarios sean más claros para quienes están empezando.
18+
19+
---
20+
21+
### **Proceso de Desarrollo**
22+
23+
Para contribuir con código, sigue este flujo de trabajo:
24+
25+
1. **Fork del Proyecto:** Crea tu propia copia del repositorio en tu cuenta de GitHub.
26+
2. **Crear una Rama:** Crea una rama para tu mejora siguiendo la convención:
27+
* `feature/nombre-de-la-mejora` para nuevas utilidades.
28+
* `fix/descripcion-del-error` para correcciones.
29+
3. **Desarrollo y Testing:** * Escribe código limpio y modular.
30+
* **Obligatorio:** Cada nueva funcionalidad debe incluir sus respectivas pruebas unitarias en **JUnit 5**.
31+
* Asegúrate de que todos los tests pasen ejecutando `mvn test`.
32+
4. **Commits:** Usa mensajes descriptivos (preferiblemente siguiendo [Conventional Commits](https://www.conventionalcommits.org/)).
33+
34+
---
35+
36+
### **Requisitos de Pull Request (PR)**
37+
38+
Al enviar un PR, asegúrate de:
39+
40+
* La rama debe estar actualizada con el `master` original.
41+
* El código debe compilar correctamente mediante `mvn clean package`.
42+
* No debe haber advertencias críticas en el análisis de código.
43+
* Describe detalladamente los cambios realizados en la descripción del PR.
44+
45+
---
46+
47+
### **Código de Conducta**
48+
49+
Se espera un trato respetuoso y profesional en todos los comentarios y discusiones del repositorio.
50+
51+
---
52+
53+
¡Gracias por ayudar a mejorar este proyecto!
54+
**Luis Cacuango** - [luiscacuango2084@gmail.com](mailto:luiscacuango2084@gmail.com)

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -103,6 +103,6 @@ javatest/
103103
### **Contribuciones**
104104
¡Las contribuciones son bienvenidas! Por favor, abre un issue o un pull request para sugerir mejoras o reportar problemas.
105105
### **Licencia**
106-
Este proyecto está bajo la licencia MIT. Consulta el archivo `LICENSE` para más detalles.
106+
Este proyecto está bajo la licencia MIT. Consulta el archivo [Licencia MIT](LICENSE) para más detalles.
107107
### **Contacto**
108-
Para preguntas o soporte, por favor contacta a [Luis Cacuango](mailto:luiscacuango2084@gmail.com).
108+
Para preguntas o soporte, por favor contacta a **Luis Cacuango** - [luiscacuango2084@gmail.com](mailto:luiscacuango2084@gmail.com).

0 commit comments

Comments
 (0)