orhun/git-cliff

Add flags and options to support user-defined templates

Ouverte

#412 ouverte le 27 déc. 2023

Voir sur GitHubGuide contributeur
 (2 commentaires) (2 réactions) (0 personne assignée)Rust (308 forks)auto 404
feature/requestgood first issue

Métriques du dépôt

Stars
 (12 040 étoiles)
Métriques de merge PR
 (Métriques PR en attente)

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

Guide contributeur

Direction de recherche
Étudiez la logique actuelle de chargement des templates dans le code (probablement dans src/template.rs ou similaire), puis ajoutez les drapeaux CLI (` templates dir`, ` list templates`) avec les variables d'environnement correspondantes et implémentez l'analyse des répertoires pour les templates définis par l'utilisateur.
Stack technique
rust
Domaine
clidevtools
Type d'issue
Fonctionnalité
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
3
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
Une demi journée
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
Rust
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
65