orhun/git-cliff

Add flags and options to support user-defined templates

Offen

#412 geöffnet am 27.12.2023

Auf GitHub ansehenContributor Guide
 (2 Kommentare) (2 Reaktionen) (0 zugewiesene Personen)Rust (308 Forks)auto 404
feature/requestgood first issue

Repository-Metriken

Stars
 (12.040 Sterne)
PR-Merge-Metriken
 (PR-Metriken ausstehend)

Beschreibung

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-Richtung
Untersuche die aktuelle Template Lade Logik im Code (wahrscheinlich in src/template.rs oder ähnlich), füge dann CLI Flags (` templates dir`, ` list templates`) mit entsprechenden Umgebungsvariablen hinzu und implementiere das Durchsuchen von Verzeichnissen nach benutzerdefinierten Templates.
Tech Stack
rust
Domain
clidevtools
Issue Type
Funktion
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
3
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Halber Tag
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
Rust
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
65