Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
77 lines (60 loc) · 2.85 KB

CONTRIBUTING.md

File metadata and controls

77 lines (60 loc) · 2.85 KB

Guía de Contribución a BACKEND_CAMERA_REVIEW

¡Hola! Gracias por considerar contribuir a BACKEND_CAMERA_REVIEW. Este proyecto es un backend robusto desarrollado en C# para la gestión y revisión de sistemas de cámaras.

Esta guía te ayudará a configurar tu entorno y seguir nuestros estándares de calidad.

Índice

  1. Código de Conducta
  2. ¿Cómo puedo contribuir?
  3. Guías de Estilo y Commits
  4. Configuración del Entorno (VS Code)

Código de Conducta

Al participar, se espera que mantengas un tono profesional y respetuoso. Reporta cualquier comportamiento inaceptable a Luis Cacuango - luiscacuango2084@gmail.com.

¿Cómo puedo contribuir?

Reportar Errores (Bugs)

Si encuentras un error, abre un Issue incluyendo:

  1. Título descriptivo: (Ej: "Excepción NullReference en el controlador de Review").
  2. Pasos para reproducir.
  3. Stack Trace: Copia el error detallado de la terminal de .NET.
  4. Entorno: Versión de .NET SDK instalada.

Tu Primer Pull Request (PR)

  1. Fork del repositorio.
  2. Crea una rama descriptiva: git checkout -b feature/nueva-funcionalidad.
  3. Asegúrate de que el proyecto compile y los tests pasen: dotnet test.
  4. Abre el Pull Request hacia la rama main.

Guías de Estilo

Estándares de Código C#

  • Convenciones: Seguimos las C# Coding Conventions oficiales de Microsoft (PascalCase para métodos/clases, camelCase para variables locales).
  • Pruebas: Utilizamos xUnit o NUnit. Cada nueva lógica debe incluir su prueba unitaria.
  • Limpieza: Antes de subir código, usa el comando de formateo: 
    dotnet format

Mensajes de Commit (Conventional Commits)

Seguimos la convención de Conventional Commits:

  • feat(camera): para nuevas funcionalidades.
  • fix(auth): para corrección de errores.
  • docs: cambios en documentación.
  • test: adición o corrección de pruebas.

Configuración del Entorno (VS Code)

Para desarrollar en este proyecto usando Visual Studio Code:

  1. Requisitos:
    • .NET SDK (Versión 8.0 o superior).
    • Extensión C# Dev Kit para VS Code.
    • Docker (opcional, para base de datos).
  2. Restaurar dependencias: 
    dotnet restore
  3. Variables de Entorno: Configura tus claves o cadenas de conexión en el archivo appsettings.Development.json. Nunca subas credenciales reales al repositorio
  4. Ejecutar Tests: 
    dotnet test
  5. Iniciar la API: 
    dotnet run --project [NombreDelProyecto].csproj