The Aldebron VSCode extension provides a streamlined interface within Visual Studio Code for selecting, commenting on, and submitting Git commits to the Aldebron platform. This extension is a component of a larger productivity tool aimed at improving software development workflows.
Overview
The Aldebron extension integrates directly into VS Code, offering a dedicated view for interacting with your Git commit history. It allows you to select a specific set of commits relevant to your current task, add individual comments to provide context, and include a general comment for the submission. Once prepared, this curated code context can be submitted to the Aldebron platform for further processing.
Features:
Commit Tree View: Displays recent Git commits in a VS Code tree view.
Interactive Commit Selection: Enables selecting multiple commits using checkboxes.
Individual Commit Commenting: Allows adding specific comments to each selected commit.
General Comment Input: Provides a field for adding a general comment for the entire submission.
Submission to Aldebron Platform: Facilitates the submission of selected commits and comments to the Aldebron backend.
Git Branch Awareness: Updates the commit view based on the current Git branch and any changes to it.
Installation
From VS Code Marketplace
Open Visual Studio Code and go to the Extensions view (Ctrl+Shift+X).
Open VS Code and go to the Extensions view (Ctrl+Shift+X).
Click on the ... menu → Install from VSIX.
Select the downloaded .vsix file.
Prerequisites
Git must be installed and accessible in your environment.
Visual Studio Code version 1.98.0 or later.
You will need an active account and be part of a workspace on the Aldebron platform to utilize the extension.
Usage
Basic Workflow
Open the Aldebron View: Access the Aldebron view by clicking its icon in the VS Code Activity Bar or by using the command palette (Ctrl+Shift+P and search for Aldebron: Focus on Aldebron View).
Select Commits: In the Aldebron view, browse the list of recent commits and use the checkboxes to select the commits you wish to include in your submission.
Add Comments: To add a comment to a specific selected commit, expand the "Selected Commits" dropdown and click on the text box icon that appears when you hover over the item. Enter your comment in the input box. You can also add a general comment using the "General Comment" input at the bottom of the view.
Submit Commits: Once you have selected and commented on your desired commits, click the "Submit Selected Commits" button at the bottom of the Aldebron view to send the data to the Aldebron platform.
Example Use Case
As a developer, you've just finished implementing a feature and have a series of commits. You need to submit these commits to the Aldebron platform so that a report of your work can be generated for your standup.
Open the Aldebron view in VS Code.
Select the commits that constitute the implementation of your feature.
Add more context to your commits by adding comments.
Add a general comment for additional context.
Click the "Submit" button. Your selected commits and comments are now sent to the Aldebron platform for processing, and can then be viewed on the web platform.
Running Locally
Setup
To set up the extension for local development or contribution:
git clone [https://github.com/dcsil/Aldebron-Code](https://github.com/dcsil/Aldebron-Code)
cd vscode-extension
npm install
Running the Extension in Development Mode
Open the cloned repository in Visual Studio Code.
IMPORTANT: Open a Visual Studio Code window with the vscode-extension directory set as the workspace:
code vscode-extension
Navigate to the "Run and Debug" view (Ctrl+Shift+D or Cmd+Shift+D).
Ensure that the "Run Extension" launch configuration is selected.
Press F5 or click the green "Start Debugging" arrow. This will compile your extension and open a new VS Code window called the "Extension Development Host".
In the "Extension Development Host" window, open a Git repository to test your Aldebron extension's functionality. The Aldebron view should appear in the Activity Bar, allowing you to interact with it.
