Every new project in the "monarch-initative" organisation MUST establish a public GitHub repository.
Every new project MUST have an associated documentation page. A documentation page MUST fulfill the following criteria:
Required information
A "home" page which explains what the project is. A Monarch Initiative logo MUST be displayed somewhere on the page.
A "contributing" page that explains, or links to an explanation, of how to contribute to the project.
A "use cases" page that explains concrete use cases of the project.
A "Other Monarch Docs" backlink to the main Monarch documentation pages (https://monarch-initiative.github.io/monarch-documentation/)
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.
A "contact" page with clear instructions on how to contact the primary maintainer of the resource.
The documentation SHOULD be maintained in markdown, and SHOULD follow the Monarch style guide.
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)
Monitor the projects issue tracker.
User issues MUST be responded to within 2 weeks.
Monarch internal issues MUST be responded to within 1 month.
Respond to non-issue-tracker user correspondence (slack or email)
User issues MUST be responded to within 2 weeks.
Monarch internal issues MUST be responded to within 1 month.
If the PCR is missing for more than 2 weeks at a time, they SHOULD name a replacement contact
The PCR MUST report progress to the wider Monarch Community and Organisation on request by Monarch Leadership.
The PCR MUST ensure the relevant SOPs to their resource, such as documentation requirements, are upheld.