Document how to use BAL

Aperta
#126 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
3/5
Tempo stimato
1-2 giorni
Idoneità per principianti
42/100
Tipo di issue
Documentazione
Chiarezza
Abbastanza chiara
Stato di attività
Ferma
Stack tecnologico
python

Direzione di ricerca

Inizia leggendo i casi di test di BAL e gli esempi di utilizzo presenti altrove nell’ecosistema OpenAssetIO per comprendere il workflow di integrazione con l’host. Documenta come viene utilizzato BAL per testare un’integrazione con l’host, mantenendo l’ambito compatibile con il lavoro pianificato in #88. Il lavoro sarà considerato completato quando i contributori avranno una guida formale all’utilizzo invece di doverla dedurre dagli esempi.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

difficulty/medium documentation good first issue help wanted

What

Add documentation on how to use BAL for testing a host integration.

Why

As more hosts adopt OpenAssetIO, BAL will become ever more crucial. Yet there is no formal documentation on its usage (test cases and example usage elsewhere in the ecosystem provide the only clues).

Notes

It's perhaps not worth being overly thorough before #88 is done.

Lingua principale
Python
Stelle
9
Fork
9
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Preparare l'ambiente

Questo progetto non fornisce container di sviluppo, Dockerfile né guida per i contributori, quindi l'ambiente è a tuo carico: parti dal suo README e consulta la nostra guida al primo contributo per i passaggi generali.

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di OpenAssetIO/OpenAssetIO-Manager-BAL

Tutte le issue di OpenAssetIO/OpenAssetIO-Manager-BAL

Issue simili

Altre issue su Python

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.