Skip to content

Latest commit

 

History

History
27 lines (19 loc) · 2.56 KB

CONTRIBUTE.md

File metadata and controls

27 lines (19 loc) · 2.56 KB

Contributing

This repository follows CDO "Continuous-release" branching. In short:

  • Please file Pull Requests against main.
  • If you wish to track this repository at a certain version, please use Git submodules to note what version you tracked.

Feedback is welcome, especially with accompanying examples, whether in worked-through RDF or as English narrative.

Creating new profiles

Profile repositories are started with an in-common Git history, rather than relying on GitHub-specific functions like templating and repository-forking. The reason for this is to assist with propagating changes seen necessary across all of the profile repositories.

To create a new profile repository for the ontology with short name Foo, we suggest:

  1. Clone the upstream example repository: git clone https://github.com/casework/CASE-Profile-Example.git CASE-Profile-Foo.
  2. Substitute all references to the "example" ontology with the desired ontology. Generally, this is handled by:
    1. Update the README to change the name of the repository. (Minimally, the title line should be revised.)
    2. Addressing the "TODOs" in dependencies/Makefile
    3. Updating the submodule pointer to the UCO profile for the external ontology. The example given is that CASE-Profile-Example's profile ontology owl:imports UCO-Profile-Example's profile ontology for the Example Ontology, with the UCO profile file tracked by Git submodule.
    4. Updating the TSV files under etc/. This is to support local-file editing with some ontology tooling (developed for UCO Issue 449). These lines describe the file formats.
    5. Renaming the ontology file under /ontology, and updating its contents.
    6. Renaming the shapes file under /shapes, and updating its contents. If the profile does not require shapes, the directory shapes can be removed.
    7. Updating the exemplars file under /tests to use all classes mapped in the profile ontology.
    8. After all of the above edits are completed, running make check from the top source directory should confirm Turtle files are normalized and unit tests pass.
  3. Push the updated profile to a new repository.