From f77c7eea42ddfb92dfa9e27f70ef285f0c1d5387 Mon Sep 17 00:00:00 2001 From: Alexander Navarro Date: Tue, 10 Sep 2024 15:53:05 +0000 Subject: [PATCH] Update Definitions --- Definitions.md | 96 +++++++++++++++++++++++++------------------------- 1 file changed, 48 insertions(+), 48 deletions(-) diff --git a/Definitions.md b/Definitions.md index 97fb280..b1234ca 100644 --- a/Definitions.md +++ b/Definitions.md @@ -1,48 +1,48 @@ -# 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 - -## Tech stack - -- Backend: - - Go - - SQLite -- Frontend: - - HTMX - - AlpineJS - - [CSS design system](https://git.alecodes.page/alecodes/mini-strap) +# 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 + +[¹]: Unspecified space of time dedicated exclusively to one task (issue in our case). This allow to do some sort of [time-boxing](https://en.wikipedia.org/wiki/Timeboxing) without committing to a date deadline. + +### 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 + +## Tech stack + +- Backend: + - Go + - SQLite +- Frontend: + - HTMX + - AlpineJS + - [CSS design system](https://git.alecodes.page/alecodes/mini-strap)