adamchainz / adamchainz/pygments-git

git-commit-edit-msg support scissors cleanup

Open
#23 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
8
Forks
0
Avg merge
1d 3h
Merged PRs (30d)
1

Description

Description

With --cleanup scissors, git commit puts the scissor line as the first comment, and anything up to it - even lines starting # - is not a comment. We should be able to highlight these non-comment # lines correctly with a special pattern that detects scissors mode.

Add “Much Ado About Nothing”

#1337 added the first Shakespeare play; this commit adds another fine
comedy.

# ------------------------ >8 ------------------------

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the git-commit-edit-msg lexer and its handling of commit-message comments, then reproduce the example with --cleanup scissors. The work is complete when # lines before the scissor marker are highlighted as commit text while the scissor line and content after it retain the expected comment treatment.

Written by the indexing model from the issue text.

Assessment

Tech stack
git, python
Domain
tooling
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.