Contribute¶
Contributions to ADIRO are welcome — a new use case, a modelling suggestion, a correction, or a new domain ontology.
Discussions vs. issues¶
- Discussions — open-ended: design notes, research write-ups, "should we model X this way?" questions, ideas not yet ready to act on.
- Issues — a concrete, actionable change, tracked to completion. Start here once there's something to act on.
How to propose a change¶
Open an issue before making a change, so the approach can be agreed and tracked against the relevant use cases first. Include:
- What you'd like to add or change, and why (ideally tied to a use case or competency question).
- Relevant AEC drawing examples, terms, or references.
Proposing a new use case or competency question works the same way — raise a Discussion if it's still an open question, or an issue once it's concrete.
Contribution guides¶
- Adding New Ontologies — how to add a new
.ttland have it documented automatically. - Data validation — the SHACL rules that check a dataset (the individuals a pipeline extracts), which the ontology cannot state under the open-world assumption.
- Example images — how to add an image that shows a class or relationship: rights and privacy, size, where the file goes and what it is called.
- Build status badges — what each badge at the top of the README measures, what red means and what to do.
- Versioning — versioned/unversioned IRIs, version backups, and how to cut a new version.
- Design Decisions — the rationale behind key modelling choices (OWL restrictions, annotation properties, relationships).