Document how to use BAL

Abierto
#126 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
3/5
Tiempo estimado
1-2 días
Aptitud para principiantes
42/100
Tipo de issue
Documentación
Claridad
Bastante claro
Estado de actividad
Estancado
Stack tecnológico
python

Línea de trabajo

Comienza leyendo los casos de prueba de BAL y los ejemplos de uso en otras partes del ecosistema OpenAssetIO para comprender el flujo de trabajo de integración con el host. Documenta cómo se usa BAL para probar una integración con el host, manteniendo el alcance compatible con el trabajo previsto en #88. Se considerará completado cuando los colaboradores dispongan de una guía formal de uso, en lugar de tener que inferirla a partir de ejemplos.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

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.

Lenguaje dominante
Python
Estrellas
9
Forks
9
Métricas de merge de PR
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 OpenAssetIO/OpenAssetIO-Manager-BAL

Todos los issues de OpenAssetIO/OpenAssetIO-Manager-BAL

Issues similares

Más issues de Python

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.