Guía de Contribución

Esta guía te ayuda a contribuir al proyecto y a documentar tus cambios de forma clara y siguiendo los estándares establecidos.

Cómo Contribuir

1. Clona tu Repositorio: Clona el repositorio desde tu cuenta de GitHub a tu máquina local.

git clone https://github.com/quetzallidevs/url

2. Crea una Rama: Antes de hacer cualquier cambio, crea una nueva rama para tus contribuciones:

git switch -c nombre-de-la-rama

3. Realiza tus Cambios: Realiza los cambios que desees en el código, asegurándote de seguir las pautas de codificación y documentación.

Envía tus Cambios: Sube tus cambios a tu repositorio en GitHub.

git add .
git commit -m "Descripción de tus cambios"
git push origin nombre-de-tu-rama

4. Crea un Pull Request: Desde tu repositorio en GitHub, crea un pull request para que tus cambios sean revisados e incorporados al proyecto principal, asegurándote de incluir una descripción a tu pull request.

## Descripción de Cambios
- [ ] Nueva funcionalidad
- [ ] Corrección de bug
- [ ] Mejora de documentación

### Contexto
¿Por qué es necesario este cambio? (Ej: Resuelve #123)

### Checklist
- [ ] Pruebas unitarias actualizadas
- [ ] Documentación actualizada
- [ ] Cumple estándares de código

### Capturas (opcional)
[Adjunta screenshots si aplica]

Pautas de Documentación

• Comentarios Descriptivos: Añade comentarios descriptivos en tu código para explicar funciones, estructuras y bloques de código complejos.

• Documentación de Funciones: Documenta tus funciones utilizando comentarios que describan su propósito, parámetros y valores de retorno.

package org.quetzallidevs.package;
/**
 * Controlador para gestionar operaciones relacionadas con calificaciones.
 * <p>
 * Maneja peticiones HTTP para crear, actualizar, consultar y eliminar calificaciones.
 * </p>
 */
public class GradeController {

    /**
     * Crea una nueva calificación.
     * @param grade La calificación a crear.
     */
    public void createGrade(Grade grade) {
        // Crea una nueva calificación
    }

}