Document how to use BAL

未关闭
#126 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

评估

难度
3/5
预计耗时
1-2 天
新手友好度
42/100
Issue 类型
文档
描述清晰度
基本清楚
活跃度
停滞
技术栈
python

调研方向

首先阅读 OpenAssetIO 生态系统其他位置中的 BAL 测试用例和使用示例,以了解主机集成工作流。记录如何使用 BAL 测试主机集成,同时确保范围与 #88 中计划的工作兼容。完成的标准是贡献者拥有正式的使用指南,而不必从示例中自行推断用法。

由索引模型根据 Issue 内容生成。

描述

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.

主要语言
Python
星标
9
派生
9
PR 合并指标
30 天内没有已合并 PR

环境准备

这个项目没有提供开发容器、Dockerfile 或贡献指南,环境需要你自己搭建:先看它的 README,通用步骤见我们的新手贡献指南。

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

OpenAssetIO/OpenAssetIO-Manager-BAL 的其他 Issue

查看 OpenAssetIO/OpenAssetIO-Manager-BAL 的全部 Issue

相似的 Issue

更多 Python Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。