mainrs / mainrs/git-cm

Use templates for custom commit message formats

Open
#12 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
Rust
Stars
101
Forks
8
PR merge metrics
No merged PRs in 30d

Description

I do think that this would be a great addition to the CLI. We could provide a template that reflects the conventional commits specification but allow people to customize the template if they want to.

The template engine would need the following features:

  • variable substitutions to insert the user's answers.
  • conditional branches to allow for basic logic. This allows to not apply certain elements if no text has been entered.

A list of possible engines can be found here: https://lib.rs/keywords/template

Contributor guide

Open the contributing guide

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 reading the CLI flow that collects answers and assembles conventional-commit messages. Compare available template engines against the required variable substitutions and conditional branches, then determine how a default conventional-commits template and user customization should be configured. Done means both behaviors are supported by the CLI.

Written by the indexing model from the issue text.

Assessment

Tech stack
git, rust
Domain
cli
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.