aboutsummaryrefslogtreecommitdiffstats
path: root/doc/feature_matrix.md
diff options
context:
space:
mode:
Diffstat (limited to 'doc/feature_matrix.md')
-rw-r--r--doc/feature_matrix.md124
1 files changed, 124 insertions, 0 deletions
diff --git a/doc/feature_matrix.md b/doc/feature_matrix.md
new file mode 100644
index 00000000..91abfba2
--- /dev/null
+++ b/doc/feature_matrix.md
@@ -0,0 +1,124 @@
+# User facing capabilities
+
+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 than 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
+
+## Entities
+
+The most high level overview of what kind of entities are supported and where.
+
+| | Core | CLI | TermUI | WebUI |
+|--------------|:----:|:---:|:------:|:-----:|
+| Identities | βœ… | βœ… | βœ… | βœ… |
+| Bug | βœ… | βœ… | βœ… | βœ… |
+| Board | 🟠 | 🟠 | ❌ | ❌ |
+| Pull-request | ❌ | ❌ | ❌ | ❌ |
+
+More specific features across the board.
+
+| | Core | CLI | TermUI | WebUI |
+|--------------------|:----:|:---:|:------:|:-----:|
+| Media embedding | 🟠 | ❌ | ❌ | ❌ |
+| Fast indexing | βœ… | βœ… | βœ… | βœ… |
+| Markdown rendering | N/A | ❌ | ❌ | βœ… |
+
+#### Identities
+
+| | Core | CLI | TermUI | WebUI |
+|-------------------------|:----:|:---:|:------:|:-----:|
+| Public keys | 🟠 | ❌ | ❌ | ❌ |
+| Private keys management | 🟠 | ❌ | ❌ | ❌ |
+| Identity edition | βœ… | βœ… | ❌ | ❌ |
+| Identity adoption | βœ… | βœ… | ❌ | ❌ |
+| Identity protection | 🟠 | ❌ | ❌ | ❌ |
+
+#### Bugs
+
+| | Core | CLI | TermUI | WebUI |
+|-------------------|:----:|:---:|:------:|:-----:|
+| Comments | βœ… | βœ… | βœ… | βœ… |
+| Comments edition | βœ… | βœ… | βœ… | βœ… |
+| Comments deletion | βœ… | ❌ | ❌ | ❌ |
+| Labels | βœ… | βœ… | βœ… | βœ… |
+| Status | βœ… | βœ… | βœ… | βœ… |
+| Title edition | βœ… | βœ… | βœ… | βœ… |
+| Assignee | ❌ | ❌ | ❌ | ❌ |
+| Milestone | ❌ | ❌ | ❌ | ❌ |
+
+
+## Bridges
+
+### Importers
+
+General capabilities of importers:
+
+| | Github | Gitlab | Jira | Launchpad |
+|-------------------------------------------------|:------:|:------:|:----:|:---------:|
+| **incremental**<br/>(can import more than once) | βœ… | βœ… | βœ… | ❌ |
+| **with resume**<br/>(download only new data) | βœ… | βœ… | βœ… | ❌ |
+| **media/files** | ❌ | ❌ | ❌ | ❌ |
+| **automated test suite** | βœ… | βœ… | ❌ | ❌ |
+
+Identity support:
+
+| | Github | Gitlab | Jira | Launchpad |
+|-------------------|:------:|:------:|:----:|:---------:|
+| **identities** | βœ… | βœ… | βœ… | βœ… |
+| identities update | ❌ | ❌ | ❌ | ❌ |
+| public keys | ❌ | ❌ | ❌ | ❌ |
+
+Bug support:
+
+| | Github | Gitlab | Jira | Launchpad |
+|------------------|:------:|:------:|:----:|:---------:|
+| **bug** | βœ… | βœ… | βœ… | βœ… |
+| comments | βœ… | βœ… | βœ… | βœ… |
+| comment editions | βœ… | ❌ | βœ… | ❌ |
+| labels | βœ… | βœ… | βœ… | ❌ |
+| status | βœ… | βœ… | βœ… | ❌ |
+| title edition | βœ… | βœ… | βœ… | ❌ |
+| Assignee | ❌ | ❌ | ❌ | ❌ |
+| Milestone | ❌ | ❌ | ❌ | ❌ |
+
+Board support:
+
+| | Github | Gitlab | Jira | Launchpad |
+|-----------|:------:|:------:|:----:|:---------:|
+| **board** | ❌ | ❌ | ❌ | ❌ |
+
+### Exporters
+
+**General capabilities of exporters**:
+
+| | Github | Gitlab | Jira |
+|-------------------------------------------------|:------:|:------:|:----:|
+| **incremental**<br/>(can export more than once) | βœ… | βœ… | βœ… |
+| **with resume**<br/>(upload only new data) | βœ… | βœ… | βœ… |
+| **automated test suite** | βœ… | βœ… | ❌ |
+
+**Identity support**:
+
+| | Github | Gitlab | Jira |
+|-------------------|:------:|:------:|:----:|
+| **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**:
+
+| | Github | Gitlab | Jira |
+|------------------|:------:|:------:|:----:|
+| **bugs** | βœ… | βœ… | βœ… |
+| comments | βœ… | βœ… | βœ… |
+| comment editions | βœ… | βœ… | βœ… |
+| labels | βœ… | βœ… | βœ… |
+| status | βœ… | βœ… | βœ… |
+| title edition | βœ… | βœ… | βœ… |
+| Assignee | ❌ | ❌ | ❌ |
+| Milestone | ❌ | ❌ | ❌ |