OpenAssetIO / OpenAssetIO/OpenAssetIO
Add documentation on "where to put things" as a contirbutor
Nobody has claimed this yet.
- Dominant language
- C++
- Stars
- 348
- Forks
- 47
- PR merge metrics
- No merged PRs in 30d
Description
What
Ensure contributors to the project know where new files/code/badgers/etc should go in the repo filesystem structure.
Why
We are looking forward to a future where external contributors feel they "know what to do" without asking team member.
ACs
PROJECT_STRUCTURE.mdadded todocs/contributingthat:- Includes the flow chart from DR13
- Minimal wording explaining how to navigate the process of deciding on a home for new files.
Notes:
The story points are a reminder not to get carried away.
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
Read the project-structure decision at doc/decisions/DR013-Project-structure.md and review the existing docs/contributing layout. Add docs/contributing/PROJECT_STRUCTURE.md with the DR013 flow chart and minimal guidance for deciding where new files or code belong. Done means the file exists in that location and covers the acceptance criteria without expanding beyond the stated scope.
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
- Clearly specified
- Newbie friendliness
- 55/100