03_Contributing.md

Contributing

• Introduction
• Updating the Metrics Markdown
• Updating the Tools Markdown

Introduction

This code for this repository is written in Scala leveraging the fgbio toolkit.

All contributions must be tested, documented, and code reviewed.

No changes should be pushed to the main branch.

When the definition or documentation for metrics or command line tools are updated or added, please update the Markdown documentation below for metrics and tools.

Updating the Metrics Markdown

The metric descriptions listed here is auto-generated with the following script:

bash src/scripts/build_metric_docs.sh

You will need to install jq via sudo apt-get install jq (for Debian/Ubuntu) or brew install jq for OSX.

Updating the Tools Markdown

The tool descriptions listed here is auto-generated with the following script:

bash src/scripts/build_tool_docs.sh