github-linguist/linguist

Add `gitcommit` and `gitrebase` language?

Open

#5,598 opened on Oct 15, 2021

View on GitHub
 (5 comments) (3 reactions) (0 assignees)Ruby (5,166 forks)batch import
Add LanguageGood First Issue

Repository metrics

Stars
 (13,466 stars)
PR merge metrics
 (Avg merge 102d 5h) (19 merged PRs in 30d)

Description

Language name

  • Git Commit
  • Git Rebase

URL of example repository

I think this is N/A, since a normal repository wouldn't commit any files that are in the .git directory.

URL of syntax highlighting grammar

Most popular extensions

Likely N/A, but the filenames are

  • COMMIT_EDITMSG
  • git-rebase-todo

Detected language

None/Plain text

While the files themselves are unlikely to be present in a repository (there are a lot of results for COMMIT_EDITMSG, though), GitHub also uses linguist to highlight code blocks in Markdown, per my understanding.

Considering that these are common git use cases, I believe that the option to highlight their syntax in Markdown should be available. I think that GitHub should support syntax highlighting for git filetypes :laughing:

If it is reasonable to support syntax highlighting for these types of files, could you please consider it?

Contributor guide

Research direction
Review the linguist documentation on adding languages and examine existing grammar definitions. Then create a new language entry for Git Commit and Git Rebase, including the appropriate scope names and filenames (COMMIT EDITMSG and git rebase todo).
Tech stack
ruby
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.
1-3 hours
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
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70