Saltar al contenido principal

Estilo de código y pautas

Convenciones de código para contribuir a los repositorios de Kleros.

Git

Mensajes de commit

Sigue Conventional Commits:
Tipos: feat, fix, docs, chore, test, refactor, style, perf, ci, build El monorepo kleros-v2 lo aplica con commitlint y Commitizen.

Nombres de ramas

Usa nombres de rama descriptivos con el tipo como prefijo:

Solidity

Versión

Los contratos de Kleros V2 usan Solidity 0.8.24. Fija la versión en el pragma:

Formato

Los repositorios de Kleros usan Prettier con el plugin de Solidity. La configuración está en la raíz del repositorio.

Convenciones

  • Usa comentarios NatSpec (/// o /** */) en todas las funciones públicas y externas
  • Agrupa las secciones del contrato con encabezados de comentario:
  • Usa la anotación custom:oz-upgrades-unsafe-allow constructor en los contratos proxiables UUPS
  • Usa el patrón reinitializer(n) para inicializar los contratos actualizables
  • Prefiere la visibilidad explícita (public, external, internal, private)
  • Usa require con mensajes de error o errores personalizados

Patrón de proxy

Los contratos de V2 usan el patrón de proxy UUPS. Los contratos de implementación heredan de UUPSProxiable e Initializable:

Lenguajes web (TypeScript/React)

Formato

  • Prettier para el formato (configuración en la raíz del repositorio)
  • ESLint para el linting (configuración en .eslintrc o en el paquete eslint-config/)

Convenciones

  • Modo estricto de TypeScript
  • Componentes funcionales de React con hooks
  • Nombres de archivo: kebab-case para los archivos, PascalCase para los componentes
  • Usa la biblioteca compartida kleros-app para los hooks y utilidades comunes de React
  • El código generado (por ejemplo, los bindings de tipos de los contratos) va en src/hooks/contracts/generated.ts

Ejecutar los linters

La CI ejecuta el linting en todas las pull requests. Las PR con errores de linting no superan las comprobaciones.