Contributing¶
Thank you for your interest in Universal Ontology Definition! We welcome contributions of all kinds.
Contribution Types¶
| Type | Description | Difficulty |
|---|---|---|
| Definition errors, missing relations, JSON format issues | ⭐ | |
| Improvement proposals for Core Ontology | ⭐ | |
| Improve docs, fix translations, add examples | ⭐⭐ | |
| Contribute new industry domain packages | ⭐⭐⭐ | |
| Structural changes to L1 core layer | ⭐⭐⭐⭐ |
Code of Conduct¶
All participants must follow our Code of Conduct.
Modifying Core Ontology (L1)¶
Core Ontology is the foundation of the entire framework. Changes require careful review.
Principles¶
- Stability First — L1 only accepts cross-industry, cross-enterprise universal abstractions
- Non-destructive — Addition preferred over modification; modification preferred over deletion
- Well-reasoned — Must explain rationale and impact scope
Process¶
- Submit an Issue to discuss your proposal
- After maintainer agreement, fork the repository
- Make changes in the
core/directory - Validate against
schema/core_schema.json - Explain rationale and impact analysis in the PR description
- Wait for at least 2 maintainer approvals
Contributing Industry and Domain Extension (L2)¶
We highly welcome new Industry and Domain Extension!
- Copy
extensions/_template/toextensions/your-industry/ - Follow naming convention: lowercase + hyphens (e.g.,
financial-services) - All classes must inherit from L1 via
parentfield - Include at least 10 classes, 5 relations, 5 sample instances
- Write a complete README
- Validate against
schema/extension_schema.json - Submit a PR
See the detailed Extension Development Guide.
Pull Request Workflow¶
- Fork the repository
- Create a feature branch:
git checkout -b feature/your-feature-name - Commit:
git commit -m "feat: add healthcare Industry and Domain Extension" - Push:
git push origin feature/your-feature-name - Create a Pull Request using the project's template
Commit Message Convention¶
Follow Conventional Commits: