Skip to content

Commit

Permalink
adds new section for dev/rel cycle structure & diagram
Browse files Browse the repository at this point in the history
  • Loading branch information
lizgehret committed Nov 14, 2024
1 parent da33765 commit a1b27bb
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 0 deletions.
Binary file added book/_static/q2-dev-cycle-diagram.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions book/_toc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,7 @@ parts:
- file: framework/references/intro
sections:
- file: framework/references/archive-versions
- file: framework/references/dev-cycle-structure

- caption: "Documentation 📚"
chapters:
Expand Down
17 changes: 17 additions & 0 deletions book/framework/references/dev-cycle-structure.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# QIIME 2 Development and Release Cycle Structure

In the sections below, we will go through the development cycle structure and release process for QIIME 2.
The aim is to provide insight into our structure for other research software engineering teams that may want to utilize any/all of these processes, as well as to assist our community developers in knowing what timeline/deadlines they should be aware of within each development/release cycle.
If you have any questions on this process, please don't hesitate to reach out on our user forum under the [Developer Discussion](https://forum.qiime2.org/c/dev-discussion) category!

## QIIME 2 Release Cycle Structure

As of 2024.10, QIIME 2 Distributions are released bi-anually, on the first Wednesday of April and October.
This schedule provides us with ample development time between releases, and provides our developer community with at least a three month notice for any external dependency changes (i.e. bumping Python, removing a deprecated package, etc).

The following diagram outlines relevant timepoints between each release, with terms defined below.

```{image} ../../_static/q2-dev-cycle-diagram.png
:align: center
:width: 400
```

0 comments on commit a1b27bb

Please sign in to comment.