Contributing¶
Everything on this site is edited through GitHub, so every change has a recorded author, rationale, and review.
First contributions¶
You do not need to be an ontologist or a programmer to help. Useful first contributions include:
- Commenting on a design pattern. Is a definition clear? Does the pattern fit a case from your legal system? Comment at the foot of the page, or in Discussions.
- Suggesting a legal ontology or vocabulary for the registry or for alignment, with a link and its license.
- Contributing a worked example: a lease, an appointment, a statute and its implementing regulation, from your jurisdiction.
- Adding a reading to the Literature pages.
Issues labeled good first issue are small, self-contained starting points. If you are unsure where something goes, open a thread in Discussions and a coordinator will help.
Editing a page¶
- Click the pencil icon at the top of any page.
- GitHub opens the Markdown source. Make your edit.
- Describe the change and choose Propose changes. This creates a pull request.
- A coordinator reviews and merges it, and the site rebuilds automatically.
The registry and ontology detail pages are generated: to change them, edit
the ontology's metadata file in ontology/ instead.
Local preview¶
python3 -m venv venv && source venv/bin/activate
pip install -r requirements.txt
python scripts/build_registry.py
mkdocs serve
Where things go¶
| Contribution | How |
|---|---|
| Idea or open question | Discussions |
| New ontology | New ontology request SOP |
| Change to a principle or policy | Pull request, plus an announcement in Discussions (see Governance) |
| New term or term fix | The ontology's own tracker (see Term requests) |
| Ontology review | Review SOP |