Reglas para contribuciones Open‐Source en Mi‐Horario‐Uniandes
¡Gracias por considerar contribuir a Mi-Horario-Uniandes! Valoramos y apreciamos la colaboración de la comunidad para mejorar nuestro proyecto. Para mantener la calidad y coherencia del código, hemos establecido algunas pautas y procesos para las contribuciones.
En el apartado Discussions se debe crear una nueva discusión con la categoría Ideas en la cual debe describir detalladamente lo que planea hacer, mencionar cuál es el aporte de calidad, cómo mejoraría la experiencia de usuario entre otras cosas.
Antes de realizar cualquier cambio, crea una rama en tu repositorio local. Utiliza un nombre descriptivo relacionado con la función o corrección que estás implementando.
Realiza los cambios necesarios en tu rama local. Asegúrate de seguir las mejores prácticas de codificación y las convenciones establecidas en el proyecto.
Antes de enviar una solicitud de pull request, asegúrate de que tu código funcione correctamente. Ejecuta pruebas unitarias y realiza pruebas manuales si es necesario.
Cuando estés listo para contribuir, crea una solicitud de extracción desde tu rama hacia la rama principal del repositorio. Proporciona información detallada sobre los cambios realizados y las razones detrás de ellos.
Los colaboradores y los administradores del repositorio revisarán tu código. Asegúrate de responder a cualquier comentario y realizar ajustes según sea necesario.
Una vez que tu código ha sido aprobado, se fusionará con la rama principal. Los mantenedores realizarán la fusión después de revisar y aprobar la contribución.
- Sigue las convenciones de estilo de código del proyecto.
- Utiliza comentarios descriptivos para explicar el propósito de las funciones y componentes.
- Proporciona documentación clara y concisa para cualquier nueva función o cambio importante.
- Actualiza la documentación existente si es necesario.
- Mantén los pull requests pequeños y centrados en un solo problema o mejora.
- Incluye pruebas que demuestren la efectividad y la corrección de tu contribución.
- Incluye tu nombre y contacto en la sección de colaboradores.
- Utiliza un lenguaje respetuoso y constructivo en los comentarios y discusiones.
- Está abierto a recibir comentarios y sugerencias.
Si encuentras problemas con el código existente, sigue estos pasos al reportar problemas:
- Descripción del problema.
- Pasos para reproducir el problema.
- Resultados esperados y resultados reales.
- Cualquier información adicional relevante.
De esta manera podrás informar de cualquier problema, haciendo clic aqui.
¡Gracias por contribuir a Mi-Horario-Uniandes! Tu esfuerzo ayuda a mejorar la calidad del proyecto y beneficia a toda la comunidad.
