streamich/git-cz

Semantic branch names

Open

#193 opened on Jul 17, 2020

View on GitHub
 (1 comment) (0 reactions) (0 assignees)JavaScript (111 forks)github user discovery
enhancementhelp wanted

Repository metrics

Stars
 (1,872 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

Add interactive command for creating semantic branch names.

image

Format would be:

<emoji>-<type>/<date>/<name>
  • type is one of

Example:

🔥-hotfix/2020-07-17/broken-db-connection

Command could be:

git-cz b
git-cz branch
  • type and emoji should be customizable.
  • default types are
    • feat
    • fix
    • hotfix
    • release
  • date should be in YYYY-MM-DD format.
  • date could be disabled in config

Contributor guide

Research direction
Examine the existing command structure in git cz, implement a new 'branch' subcommand that prompts for type, emoji, date, and name, and formats the output as specified. Ensure customization via configuration file.
Tech stack
javascript
Domain
cli
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
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75