Modules
Modules are smaller, focused projects that help users group and organize issues within specific time frames. They allow teams to break down their work into manageable chunks and track progress towards specific goals or objectives. They can serve various purposes: tracking progress on a new feature, managing a milestone like a marketing campaign, or representing discrete pieces of your software architecture such as a microservice.
Enable Modules
By default, Modules are enabled for all new projects. If you need to enable or disable them later, head to Project settings and toggle the Modules feature as needed.
Create Module
To create a new Module:
- Press
M
from anywhere in the project or navigate to the Modules page on the sidebar and click Add Module. - Provide a name for the Module.
- Optionally, add a description, state, designate a lead, and set start and due dates (these can also be added later).
You can add Members to the Module irrespective of whether they are the assignees in the issues present in the Module.
Add issues to Module
Once your Module is created, you can populate it with issues:
-
Add new or existing issues directly from the Module page.
-
Assign multiple Modules to an issue from its properties. For instance, an issue can belong to both a Feature module and a Release module simultaneously.
Module states
Modules can be in one of the following states:
-
Backlog - Newly created Modules start here by default.
-
Planned - Indicating that the Module has been scheduled.
-
In Progress - Work on the Module has started.
-
Paused - Temporarily on hold.
-
Completed - All issues in the Module are in the Done state.
-
Cancelled - The Module has been discontinued.
These states provide a clear picture of where each Module stands in your project timeline. Users can plan their Modules with these statuses, offering clarity about the progress and current stage of each Module.
Module progress
Module progress is calculated based on the number of completed issues within the Module. This offers a quick overview of how much work remains before the Module can be closed. Each Module comes with analytics and metrics, empowering teams to assess performance and the success of their goals.
View Module details
-
To view the issues within a module, simply click on the module itself.
-
For detailed information about the module, click the info icon next to the module name. This will display the following details:
- Name, description, Members, and assigned lead
- Start and due dates
- Issues in the Module and their statuses
- Progress indicators
- Additional properties like assignees, labels and states
Search, sort, and filter Modules
Quickly locate specific Modules using the search, sorting, and filtering options. You can sort Modules by name, state, or due date, and apply filters to focus on relevant Modules.
Module layouts
Visualize your Modules in different layouts:
-
List layout – For simple ordered list of Modules in the project.
-
Gallery layout – Displays Modules as cards, with a clear breakdown of issue counts by state for better visibility.
-
Timeline layout – Displays the sequence of goals and their progress, helping you ensure your project is on track.
Easily share a Module by copying its link. Mark frequently used Modules as favorites for quick access.
Archive Module
Archive completed Modules to declutter your views while preserving historical data. This feature is ideal for concealing older, no-longer-active Modules. You can access them in the project's Archives option.
Delete Module
If a Module is no longer needed, you can delete it. Deleting a Module removes its progress analytics and de-links all associated issues.