Add Definitions

Alexander Navarro 2024-09-06 12:54:49 -04:00
parent 34216a69a6
commit 5f812aadb1
Signed by untrusted user who does not match committer: anavarro
GPG key ID: 6426043E9FA3E3B5

38
Definitions.md Normal file

@ -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