Developer guide: add more about validation
@yarikoptic がすでに取り組んでいます。
2023年8月14日 から。
評価
この issue はまだ評価されていません。
説明
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.
- 主要言語
- 言語のデータがありません
- スター
- 6
- フォーク
- 19
- PR マージ指標
- 30日以内にマージされた PR はありません
環境構築
このプロジェクトには開発コンテナ、Dockerfile、コントリビューションガイドがありません。まず README を読み、一般的な手順ははじめてのコントリビューションガイドを参照してください。
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
dandi/dandi-docs のほかの issue
-
Add ANSI color rendering to validation output code blocks再び着手できるかも @yarikoptic が 211 日前に担当しましたが、オープン中のプルリクエストはありません。 オープン
dandi/dandi-docs#234 · 担当者 1 名 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 50/100
dandi/dandi-docs#228 · コメント 7 件 · リアクション 1 件 ·
-
Adopt feature for section context menu on the right再び着手できるかも このイシューのプルリクエストはマージされずにクローズされました。 オープン
dandi/dandi-docs#216 · リアクション 1 件 · 担当者 1 名 ·
-
難易度 3/5 1〜2日 初心者へのやさしさ 42/100
dandi/dandi-docs#211 ·
-
難易度 3/5 1〜2日 初心者へのやさしさ 38/100
dandi/dandi-docs#201 ·