OpenAssetIO / OpenAssetIO/OpenAssetIO
[Docs] Add README for `openassetio.test` manager test harness
Nobody has claimed this yet.
- Dominant language
- C++
- Stars
- 348
- Forks
- 47
- PR merge metrics
- No merged PRs in 30d
Description
What
Add a README explaining the purpose and usage of the manager test harness.
Why
This follows https://github.com/OpenAssetIO/OpenAssetIO/pull/740#issuecomment-1315638789 (and related earlier comments).
It is not immediately clear when browsing the repository that openassetio.test.manager is not related to our unit tests.
It's also an independent executable that is somewhat distinct from the rest of the openassetio package and could do with it's own documentation.
Contributor guide
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 inspecting the openassetio.test.manager harness and its independent executable entry point to understand its purpose and usage. Add a README that explains how it differs from the repository's unit tests and how to use it; the work is done when browsing the package makes that distinction clear.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100