Microsoft/vscode

Git - Expose git branch description on VS code UI

Open

#197,752 opened on Nov 8, 2023

View on GitHub
 (3 comments) (27 reactions) (1 assignee)TypeScript (74,848 stars) (10,221 forks)batch import
feature-requestgithelp wanted

Description

Git 1.7.9 supports descriptions on branches. It's really extremely helpful for large projects and actually amazing it was not part of the original release of git. However it's a big hassle in VS code to have to open terminal and type git branch --edit-description to view or edit the branch description.

Can we simply add an input text box somewhere which exposes this field? it would also be ideal to expose it on the branch select popup which appears when you click the active branch in the bottom left of VS code.

Contributor guide

Tech stack
typescriptnodejselectron
Domain
frontenddeveloper experience
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Git basicsVS Code extension APITypeScriptUI components
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
20
Research direction
This issue is assigned, so first time contributors should look for unassigned issues. To understand the technical approach, examine the VS Code Git extension source code under extensions/git/src/. The branch description feature involves modifying the branch picker UI, likely in src/views/branch.tsx. Review existing comments for any additional context.