How to Report Bugs and Request Features

Bug reports and feature requests are tracked through GitHub Issues. Please open an issue when you find a bug, hit a documentation gap, or want to propose a new workflow.

To help us respond quickly and effectively, please follow the guidelines below.

Bug Report Format

When reporting a bug, please include:

1. System information

   • Operating system (e.g., Windows 11, macOS Sonoma, Ubuntu 22.04)
   • Python version (e.g., 3.10.12)
   • Sequenzo version (e.g., 0.1.16)
   • Machine specs (CPU type, number of cores, RAM, clock speed, e.g., “AMD 8-core, 16GB RAM, 3.2 GHz”)

2. Minimal reproducible code example A small snippet that clearly shows the problem.

3. Observed output

   • Error message or traceback (copy/paste or screenshot)
   • If related to visualization, a screenshot of the plot/output

4. Expected behavior A short description of what you thought should happen.

Feature Request Format

When suggesting a feature, please include:

1. Motivation Why is this feature useful? What problem does it solve?

2. Proposed solution A short description of how you imagine the feature would work (e.g., input, and output).

3. Context

   • Your typical use case or dataset size
   • Any performance considerations (e.g., “40k sequences, 200 time points, 16GB RAM”)

Response Policy

• Maintainers respond as quickly as possible.
• For requests that are not too large, we aim to fix or implement the feature within one week from our response time.
• Timeline may vary depending on how many requests we receive.

Author: Yuqi Liang