Developer guide: add more about validation

Abierto
  • ¿Algo no está bien?
#91 1 comentario 0 reacciones 1 asignado Ver en GitHub

@yarikoptic ya está trabajando en esto.

Desde el 14/8/2023.

Evaluación

Este issue todavía no se ha evaluado.

Descripción

ATM we have quite a lot of "heterogeneity" in how we do validation. We have multiple layers

  • pynwb

  • bidsschematools

  • nwbinspector

  • dandischema

  • dandi-cli glueing: uses above + adding more (zarr checking) - relies on content to be available, not just validation of extracted metadata

  • dandi-archive: invokes validations of dandischema, validates extracted metadata, not relying on content being present

We also have two "dataset layouts": DANDI and BIDS, with DANDI being our "ad-hoc" layout which is instrumented in code in dandi-cli.

NB We might move DANDI layout into dandischema

We have https://www.dandiarchive.org/handbook/135_validation/ which outlines to user only some, very limited, set of validations. We should get some more detailed description of "validation framework" and "DANDI layout" here.

edit: and then worth getting some meeting/presentation for DANDI team to sync our knowledge etc on all these aspects.

Lenguaje dominante
Sin datos de lenguaje
Estrellas
6
Forks
19
Sin PR fusionados en 30 d

Preparar el entorno

Este proyecto no incluye contenedor de desarrollo, Dockerfile ni guía de contribución, así que la configuración corre por tu cuenta: empieza por su README y consulta nuestra guía para la primera contribución para los pasos generales.

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de dandi/dandi-docs

Todos los issues de dandi/dandi-docs

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.