Skip to content

Monarch Standard Operating Procedures

New projects

Creating a new project

  1. Every new project in the "monarch-initative" organisation MUST establish a public GitHub repository.
  2. Every new project MUST have an associated documentation page. A documentation page MUST fulfill the following criteria:
    1. Required information
      1. A "home" page which explains what the project is. A Monarch Initiative logo MUST be displayed somewhere on the page.
      2. A "contributing" page that explains, or links to an explanation, of how to contribute to the project.
      3. A "use cases" page that explains concrete use cases of the project.
      4. A "Other Monarch Docs" backlink to the main Monarch documentation pages (https://monarch-initiative.github.io/monarch-documentation/)
      5. An "Editors guide" that explains how the resource is maintained. The information should be sufficient for a new developer to take up maintenance of the resource.
      6. A "contact" page with clear instructions on how to contact the primary maintainer of the resource.
    2. The documentation SHOULD be maintained in markdown, and SHOULD follow the Monarch style guide.
  3. Every new project MUST assign an accountable contact person.
  4. Every new project MUST be registered in the Monarch Asset Registry database.
  5. Every new project that is either a new ontology, a new datamodel or schema, or a new software project, MUST follow their respective SOP (see below).

Creating a new ontology

  1. Every new ontology MUST use a standard ODK setup.

Creating a data model or schema

  1. Every new data model MUST use the LinkML Project Template.

Creating a new Python project

  1. Every new python project in Monarch SHOULD use the Monarch Project Template to ensure uniform QC standards.

Monarch Style guide

  • Monarch documentation pages SHOULD follow the "materials" theme provided by the mkdocs framework. NOTE: This recommendation is provisional until we have a better colour scheme in place.

Responsibilities of the "primary contact" of a resource (PCR)

  1. Monitor the projects issue tracker.
  2. User issues MUST be responded to within 2 weeks.
  3. Monarch internal issues MUST be responded to within 1 month.
  4. Respond to non-issue-tracker user correspondence (slack or email)
  5. User issues MUST be responded to within 2 weeks.
  6. Monarch internal issues MUST be responded to within 1 month.
  7. If the PCR is missing for more than 2 weeks at a time, they SHOULD name a replacement contact
  8. The PCR MUST report progress to the wider Monarch Community and Organisation on request by Monarch Leadership.
  9. The PCR MUST ensure the relevant SOPs to their resource, such as documentation requirements, are upheld.