Home

Welcome to the diverse-seq Developer Guide

Here you will find important information about how to contribute to the DiverseSeq project.

Important

First time contributors must read the Code of conduct.

Getting Started

• Code of conduct
• The cogent3¹ developer environment setup instructions are a great place to go for guidance on configuring your system.
• The cogent3¹ development workflow outlines the workflow used in DiverseSeq.
• The cogent3¹ development practices mirror those used for DiverseSeq — remember to replace command-line usages of cogent3 with DiverseSeq!

Types of Issues

• Adding a new feature

Coding Guidelines

We employ the cogent3¹ guidelines for:

• Code style
• Writing tests

---

Footnotes

1. We do not have some DiverseSeq-specific resources (like a Docker container). However, our process is closely aligned with the cogent3 project, so in adherence with the DRY principle, some links on this page take you to the corresponding cogent3 contributor guidelines. Although these guidelines are written as if specific for cogent3, they apply to all open-source projects!