Versonote

Table of Contents

• Product Description
• How It Works
• Demo & Screenshots
• Open Source Information
• Changelog
• Copyright & License Information
• Contributors
• FAQs
• Article Links

Product Description

Devs are often forced to disconnect from their codebase for meetings, code review, or branch switching for collaboration. Once they return to their codebase, finding relevant files and recalling their train of thought disrupts their flowstate. Additionally, keeping a mental to-do list and working off of incomplete code snippets applies cognitive stress and increases the risk of critical details falling through the cracks.

Versonote is a VSCode extension that stores the current state of the codebase and a handover note detailing next steps, allowing either you or the developer after you to continue the work without issue. Versonote also provides users with access to git commands without needing to enter commands in the terminal, providing users with the option for more windowspace.

Versonote utilizes ESbuild to implement a dual-runtime. This allows Node.js methods to be invoked within the extension's React components. Versonote also lets users invoke common git commands without needing to use the terminal directly by incorporating SimpleGit.

How It Works

1. Download a copy of the Versonote GitHub repo to your local computer and open it in VS Code. Alternatively, fork and clone a copy of this repo.
2. Run ‘npm install’ in the terminal. Then, run 'npm run watch' to allow the frontend to listen to changes from the backend through esbuild.
3. Go to the Activity Bar, and choose Run and Debug. Click Start Debugging OR go to the Title Toolbar, choose Run, and click Run Without Debugging.
4. In the debugger window, open a file folder (repo) from your local computer.
5. Branches display a dropdown list of branches in your open repo.
   • The current branch is starred and highlighted.
   • Any handover notes left on the current branch are displayed under Handover.
6. To switch branches, click the Branches dropdown menu and choose a branch.
   • If successful, a pop-up window in the bottom left-hand corner appears saying “Switched to [branch-name]”.
   If unsuccessful, an error message pops up instead.
7. Handover displays the handover notes left on a branch. To leave a handover note, type your note in the “Handover note” textfield and click Submit.
8. Commits include 5 buttons invoking git stash, stage, commit, push, or pull. To commit the latest changes, type your commit message in the “Enter commit message” textfield, then press Commit.

Demo

Open Source Information

Relevant Tech Stacks

VSCode API:

• Filesystem
• Webview
• Window
• Workspace

ESBuild

SimpleGit

To contribute, please fork and clone this repo. Note, any edits made to the codebase will be compiled by running "npm run watch." We welcome collaboration, and do not hesitate to reach out to us via LinkedIn or Github!

Features:
Implemented -

• Simplegit functionality implemented for: branch switching
• Handover note fully functional

In Progress -

• Storing and displaying the commit hash
• Implementing other git command functionality, including add, push, pull, commit, stash, etc.

We Welcome Collaboration -

• Comment anchors that store a user's comments and displays them over the code as to not clutter the lines in the codebase directly.

Changelog

0.2: Initial beta launch with working handover note and git functionality with Simplegit. Extensions runs within the VSCode Debugger.

Copyright and License Information

This project is distributed under the MIT License (see the LICENSE file in the project root).

By submitting a pull request to this project, you agree to license your contribution under the MIT License.

Contributors

Arsalan Zubair Github LinkedIn	Laynie Buten Github LinkedIn	Rose Raposo Github LinkedIn	Karina Solomon Github LinkedIn	Lawrenzo Lue Github LinkedIn