Skip to content

Commit 47650bd

Browse files
authored
Update ROADMAP.md
Define a ROADMAP to streamline work over the next few months. The roadmap is split across three sections - CI/CD, new features, and maintenance. Each item should have a Why and a What to concisely describe the value proposition for that item.
1 parent 4d70b4d commit 47650bd

File tree

1 file changed

+23
-16
lines changed

1 file changed

+23
-16
lines changed

ROADMAP.md

Lines changed: 23 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,23 @@
1-
## CI/CD
2-
* Setup builds on each PR and commit
3-
* Start adding unit tests for Python & ReactJS
4-
* Add UI integration tests and integrate with CI/CD tooling
5-
6-
## Existing Features
7-
* Perform a UX review of existing features
8-
* Incorporate design feedback from UX review for existing features
9-
10-
## New features
11-
* Define the REST API for Cloning a Git repo
12-
* Define the UX for Cloning a Git Repo
13-
* Implement the UX for cloning a Git repo
14-
* Define the REST APIs for Push/Pull
15-
* Define the UX for Push/Pull
16-
* Implement the UX for Push/Pull
1+
## CI/CD:
2+
- CD: Trigger releases on tags.
3+
- **What?** Add CD capabilities to trigger a release when a tag is pushed.
4+
- **Why?** Save maintainer manual effort on releases. Increase cadence of releases.
5+
- Combining the Python and JS files into one installable package
6+
- **What?** Provide a single installation for both the frontend and the server package
7+
- **Why?** Reduce number of issues from users have different versions of the NPM and Python packages. Easier installation for users
8+
- Integration Testing
9+
- **What?** Test suite that actually exercises UI and API against an actual Git repo without mocking out Git calls.
10+
- **Why?** Enables us to better test against an actual Git process. Stepping stone to x-OS testing such as Windows.
11+
12+
## Features
13+
- Plaintext diffs
14+
- **What?** Diff of non-notebook files such as .py files
15+
- **Why?** Fully featured diff experience for most types of files
16+
- Credentials
17+
- **What?** Credential management during push/pull/clone without actually storing credentials
18+
- **Why?** Better UX when a user doesn't have credentials for accessing a Git repo.
19+
20+
## Maintenance
21+
- Issue & Bug triage
22+
- **What?** Triage issues and fix bugs in existing featutes
23+
- **Why?** Operational maintenance of the extension

0 commit comments

Comments
 (0)