diff --git a/ROADMAP.md b/ROADMAP.md new file mode 100644 index 0000000..708bb90 --- /dev/null +++ b/ROADMAP.md @@ -0,0 +1,64 @@ +# Roadmap + +## Current Target: MVP + +The current goal for Giterated is to reach MVP. MVP is defined by a few key features, which will be outlined. + +### MVP +- Users + - Authentication + - [X] Password Authentication + - [ ] Keypair Authentication + - Customization + - [X] User Bio + - [X] Display Name + - [ ] Profile Images +- Repositories + - File Viewer + - [X] View by Branch + - [X] View by Commit + - [X] View commit information + - [ ] Browse previous commits + - [ ] Browse tags + - [X] Browse branches + - Issues + - TBD + - Settings + - TBD + - Pull Requests + - TDB +- Instance + - Usage Settings + - [ ] Limit Account Creation + - [ ] Limit Repository Creation + - [ ] Set usage limits by size quota + - Management Tools + - [ ] Event Log + - [ ] Event Stream + - [ ] User Management + - [ ] Repository Management +- Git + - HTTPS and SSH support + +### Security and Reliability testing +- Protocol Fuzzing + - TBD + +### Documentation +TBD + +## Acceptance Criteria +Giterated will be considered to have met the target of MVP when the following conditions are met: + +1. **ALL** security tests have passed and their results validated. +2. **ALL** MVP feature critera that falls in to the following categories must be implemented and integration tested: + - Authentication + - Git + - Usage Settings + - Management Tools +3. **ALL** code that falls into the following categories must be unit tested: + - Authentication + - Authorization + +## Revisions +26th Tuesday September 2023 - [View Revision](https://giterated.dev/ambee/giterated/blob/98bdb5602a6cf554670b7fcb743effdc3951f0aa/README.md) \ No newline at end of file