Contributor guide

Contributor guide

• Contributor getting started
  • Getting started working with the chap-core codebase
• Setting Up CHAP Core as a Contributor
• Important note for Windows contributors
  • First time WSL setup
  • Running commands through WSL
• Code overview
  • The chap command line interface
  • The REST API
  • External models
  • Models and ModelTemplates
• Vocabulary (domain specific terms used in the code)
  • Model template
  • Configured model
  • ExternalModel
  • Some other terms we use
  • Runner
• Testing while developing
  • The quick tests
  • The comprehensive tests
  • Some more details about integration tests
• Writing and building documentation
  • How to edit the documentation
  • How to build the documentation locally
• Creating a docker image for R models