Contributor’s Guide

Do you want to help make ViRelAy even better? There many ways in which you can contribute to the project. This guide will explain everything you need to know to improve ViRelAy’s code base and how to submit changes. Also, this guide will go into the details of ViRelAy’s architecture and the file formats used to describe ViRelAy projects.

• How to Contribute
  • Filing Bugs & Feature Requests
  • Contributing Code or Documentation
• Backend REST API
  • Command Line interface
  • REST API
  • Unit Testing
  • Linting
• Frontend
  • Development
  • Deployment
• Project File Format
• Database Specification
  • Legend
  • General Data Specification
  • Model Input Data
  • Attribution of Input Data
  • Analysis Output Data