You must have a map, no matter how rough. Otherwise you wander all over the place.
– J.R.R. Tolkein
This is a central repository that houses developer documentation with links to other pieces of developer documentation. It's meant to provide a high-level overview of development at ClinGen. Project-specific documentation should live in the same repository as the code it documents.
This is living documentation. We expect you to be proactive about fixing anything that is incorrect or outdated. Feel free to improve on anything you deem fit. At the very least, file an issue.
- Getting started
- Outlines the general steps to take when you first start work here.
- A map of ClinGen
- Describes the various parts of the ClinGen consortium and how Stanford ClinGen fits in.
- Culture and values
- Discusses the culture we are trying foster. Also discusses what we value as an organization.
- Processes
- Documents the processes that apply to any repository in the ClinGen organization.
- History
- Provides a brief history of ClinGen and some extra details on this history of Stanford ClinGen.
- Planned improvements
- Discusses our plans for improving our code and our development processes.
- Documentation
- Documents how we document things. (That's so meta!)
- Code standards
- Lists our standards for production-quality code.
- Project-specific documentation
- Links to the documentation for our projects.
The Markdown documents in this repository should be formatted using the
tasks.py Invoke script. To format all of the
files in this repository, first install
Pipenv, then format the docs:
pipenv run invoke fmt. To run pre-commit checks for this repository:
pipenv run invoke check.