Microsoft/vscode

Git - Automatically insert line breaks in git commit messages

Open

#2,718 opened on Feb 4, 2016

View on GitHubContributor guide
 (58 comments) (112 reactions) (1 assignee)TypeScript (39,847 forks)batch import
feature-requestgithelp wanted

Repository metrics

Stars
 (184,936 stars)
PR merge metrics
 (Avg merge 11h 43m) (1,000 merged PRs in 30d)

Description

I'm trying to get into the habit of writing good commit messages. Not sure if this should be the default but it would be really useful if vscode automatically wrapped commit message lines at say 80 chars and inserted line breaks.

I don't mean changing the appearance of the text in the commit message box, just before it's actually committed. The line length could be in an option too.

Contributor guide

Research direction
Look into the git extension's commit message input and find where the commit message is stored before commit. Implement automatic line wrapping at 80 characters before the commit is executed, ensuring that existing line breaks intended by the user are preserved.
Tech stack
typescript
Domain
developer experiencetooling
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70