orhun/git-cliff

Add flags and options to support user-defined templates

Open

#412 opened on Dec 27, 2023

View on GitHub
 (2 comments) (2 reactions) (0 assignees)Rust (308 forks)auto 404
feature/requestgood first issue

Repository metrics

Stars
 (12,040 stars)
PR merge metrics
 (PR metrics pending)

Description

Is your feature request related to a problem? Please describe.

I define templates by myself and want to init with same mechanism which git-cliff already support by only for built-in templates

Describe the solution you'd like

# add directory which stores user-defined templates, 
git cliff --templates-dir <PATH> (ENV: GIT_CLIFF_TEMPLATES_DIR=)

# print all available templates, both built-in and user-defined templates, which is needed for providing completion in emacs.
 git cliff --list-templates

Describe alternatives you've considered

no

Additional context

  • allow user to define his own templates
  • give a higher priority to overwrite built-in templates if they have same names

See #370

Contributor guide

Research direction
Study the current template loading logic in the codebase (likely in src/template.rs or similar), then add CLI flags (` templates dir`, ` list templates`) with corresponding environment variables and implement directory scanning for user defined templates.
Tech stack
rust
Domain
clidevtools
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.
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
Rust
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65