Git Insights

Git Insights is a Visual Studio Code extension that opens a dashboard in the editor area and shows your latest Git commits and diffs for the current workspace.

Features

• Activity Bar launcher for opening the dashboard.
• Editor-area Webview for the main dashboard.
• Latest commit list with author, timestamp, and patch text.
• Safe HTML rendering and a minimal extension host implementation.

Requirements

• Visual Studio Code 1.122.0 or newer.
• Git installed and available on your PATH.
• An open workspace folder with a Git repository.

Usage

Click the Git Insights icon in the Activity Bar, or run the Open Git Insights Dashboard command from the Command Palette.

Notes

This extension is the UI shell for a future analytics backend. Git statistics, AI summaries, and charts will be added later.

Features

Describe specific features of your extension including screenshots of your extension in action. Image paths are relative to this README file.

For example if there is an image subfolder under your extension project workspace:


Tip: Many popular extensions utilize animations. This is an excellent way to show off your extension! We recommend short, focused animations that are easy to follow.

Requirements

If you have any requirements or dependencies, add a section describing those and how to install and configure them.

Extension Settings

Include if your extension adds any VS Code settings through the contributes.configuration extension point.

For example:

This extension contributes the following settings:

• myExtension.enable: Enable/disable this extension.
• myExtension.thing: Set to blah to do something.

Known Issues

Calling out known issues can help limit users opening duplicate issues against your extension.

Release Notes

Users appreciate release notes as you update your extension.

1.0.0

Initial release of ...

1.0.1

Fixed issue #.

1.1.0

Added features X, Y, and Z.

Following extension guidelines

Ensure that you've read through the extensions guidelines and follow the best practices for creating your extension.

• Extension Guidelines

Working with Markdown

You can author your README using Visual Studio Code. Here are some useful editor keyboard shortcuts:

• Split the editor (Cmd+\ on macOS or Ctrl+\ on Windows and Linux).
• Toggle preview (Shift+Cmd+V on macOS or Shift+Ctrl+V on Windows and Linux).
• Press Ctrl+Space (Windows, Linux, macOS) to see a list of Markdown snippets.

For more information

• Visual Studio Code's Markdown Support
• Markdown Syntax Reference

Enjoy!