User facing capabilities

May 5, 2025 ยท View on GitHub

This document tries to give an overview of what is currently supported, and by extension where effort can be focused to bring feature completion and parity.

As git-bug is a free software project, accept and rely on contributor, those feature matrices kinda define a roadmap, in the sense that anything mentioned below is a planned feature and can be worked on. This does not mean that a feature not mentioned here should not be considered, just maybe check the issue tracker and come talk about it.

This document however does not show all the untold work required to support those user-facing capabilities. There has been a ton of work behind the scene and more will be required over time.

โœ…: working ๐ŸŸ : partial implementation โŒ: not working

Other goals

Some goals don't really fit below, so I'll mention them here:

  • have the webUI accept external OAuth (Github, ...) and act as a public portal where user outside the project can browse and interact with the project
  • project configuration (valid labels, ...)
  • commit signature to fully authenticate user's interaction
  • interface with the system keyring, to distribute and expose known public keys and allow checking signed commit in normal git workflow
  • privileged roles (admin, ...) and enforcing the corresponding rules
  • package the webui as a desktop app

Additionally, some other are captured as Github issues or Discussions.

Entities

The most high level overview of what kind of entities are supported and where.

CoreCLITermUIWebUI
Identitiesโœ…โœ…โœ…โœ…
Bugโœ…โœ…โœ…โœ…
Board๐ŸŸ ๐ŸŸ โŒโŒ
Pull-requestโŒโŒโŒโŒ
Project ConfigโŒโŒโŒโŒ

More specific features across the board.

CoreCLITermUIWebUI
Media embedding๐ŸŸ โŒโŒโŒ
Fast indexingโœ…โœ…โœ…โœ…
Markdown renderingN/AโŒโŒโœ…

Identities

CoreCLITermUIWebUI
Public keys๐ŸŸ โŒโŒโŒ
Private keys management๐ŸŸ โŒโŒโŒ
Identity editionโœ…โœ…โŒโŒ
Identity adoptionโœ…โœ…โŒโŒ
Identity protection๐ŸŸ โŒโŒโŒ

Bugs

CoreCLITermUIWebUI
Commentsโœ…โœ…โœ…โœ…
Comments editionโœ…โœ…โœ…โœ…
Comments deletionโœ…โŒโŒโŒ
Labelsโœ…โœ…โœ…โœ…
Statusโœ…โœ…โœ…โœ…
Title editionโœ…โœ…โœ…โœ…
AssigneeโŒโŒโŒโŒ
MilestoneโŒโŒโŒโŒ

Bridges

Importers

General capabilities of importers:

GithubGitlabJiraLaunchpad
incremental
(can import more than once)
โœ…โœ…โœ…โŒ
with resume
(download only new data)
โœ…โœ…โœ…โŒ
media/filesโŒโŒโŒโŒ
automated test suiteโœ…โœ…โŒโŒ

Identity support:

GithubGitlabJiraLaunchpad
identitiesโœ…โœ…โœ…โœ…
identities updateโŒโŒโŒโŒ
public keysโŒโŒโŒโŒ

Bug support:

GithubGitlabJiraLaunchpad
bugโœ…โœ…โœ…โœ…
commentsโœ…โœ…โœ…โœ…
comment editionsโœ…โŒโœ…โŒ
labelsโœ…โœ…โœ…โŒ
statusโœ…โœ…โœ…โŒ
title editionโœ…โœ…โœ…โŒ
AssigneeโŒโŒโŒโŒ
MilestoneโŒโŒโŒโŒ

Board support:

GithubGitlabJiraLaunchpad
boardโŒโŒโŒโŒ

Exporters

General capabilities of exporters:

GithubGitlabJira
incremental
(can export more than once)
โœ…โœ…โœ…
with resume
(upload only new data)
โœ…โœ…โœ…
automated test suiteโœ…โœ…โŒ

Identity support:

GithubGitlabJira
identitiesโœ…โœ…โœ…
identities updateโŒโŒโŒ

Note: as the target bug tracker require accounts and credentials, there is only so much that an exporter can do about identities. A bridge should be able to load and use credentials for multiple remote account, but when they are not available, the corresponding changes can't be replicated.

Bug support:

GithubGitlabJira
bugsโœ…โœ…โœ…
commentsโœ…โœ…โœ…
comment editionsโœ…โœ…โœ…
labelsโœ…โœ…โœ…
statusโœ…โœ…โœ…
title editionโœ…โœ…โœ…
AssigneeโŒโŒโŒ
MilestoneโŒโŒโŒ