From 5f812aadb144306e92af1f6bebd14b2cec4092cd Mon Sep 17 00:00:00 2001 From: aleidk Date: Fri, 6 Sep 2024 12:54:49 -0400 Subject: [PATCH] Add Definitions --- Definitions.md | 38 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 38 insertions(+) create mode 100644 Definitions.md diff --git a/Definitions.md b/Definitions.md new file mode 100644 index 0000000..59f2f97 --- /dev/null +++ b/Definitions.md @@ -0,0 +1,38 @@ +# Project definition and Scope + +## Main idea + +This project aims to extend the issue management functionality of git forges, +allowing more complex project management workflows and provide features not +included in the forge by itself. + +### What is/will be implemented: + +- [ ] view for repository and organization wide +- [ ] Issue management via labels: + - [ ] List view + - [ ] Kanban Board +- [ ] Time tracking: + - [ ] Pomodoro timmer + - [ ] Flowtime timmer +- [ ] Dependencies / blocking visualization +- [ ] Milestone management +- [ ] Calendar via due dates +- [ ] Work session[¹] management + +[¹]: How many _sessions_ (AKA sittins) this issue has done vs allows + +### What won't be implemented + +- A full jira clone +- Support for every git forge + +### Constraints + +- It needs to be a stateless application: + - Data should come primary from the git forge + - For the functionality not supported by the git forge, it needs to be stored in the frontmatter of the issue description + - Configuration needs to be done via config file, env vars or command line arguments + - Data stored in the app should only be transactional and cache in an in-memory database +- It needs to be mobile friendly +- It needs to have an extensible design