OpenAssetIO / OpenAssetIO/OpenAssetIO-Manager-BAL
Document how to use BAL
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 9
- Forks
- 9
- PR merge metrics
- No merged PRs in 30d
Description
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.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reading the BAL test cases and example usage elsewhere in the OpenAssetIO ecosystem to understand the host-integration workflow. Document how BAL is used for testing a host integration, keeping the scope compatible with the work planned in #88. Done means contributors have formal usage guidance instead of needing to infer it from examples.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation, testing-qa
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100