GithubHelp home page GithubHelp logo

Comments (7)

tbarusseau avatar tbarusseau commented on June 15, 2024 1

Are you alright with adding structopt for command-line arguments parsing?

from git-cm.

tbarusseau avatar tbarusseau commented on June 15, 2024 1

That sounds great!

from git-cm.

mainrs avatar mainrs commented on June 15, 2024

This could be taken further by introducing some kind of template where a user can define their own template and formatting (commits.template):

{type}{if has_scope: ({scope})}{if is_breaking: !}: {short_msg}
{long_msg}
{if is_breaking: BREAKING CHANGES: {breaking_changes}}
{if are_affected: issues_affected}

Just an idea :)

from git-cm.

mainrs avatar mainrs commented on June 15, 2024

I've worked with both structopt and clap. Since structopt does rely on clap anyway and has been merged into the 3.0-alpha I'd rather use that version of clap.

from git-cm.

mainrs avatar mainrs commented on June 15, 2024

I am working on #12, so this could be solved with it. Not sure if I want to add a flag for it or just provide an alternative template inside the repo that people can use, as my main goal is to follow the conventional commits specification.

from git-cm.

tbarusseau avatar tbarusseau commented on June 15, 2024

While it makes sense for the spec to separate the title, body, and footer, on shorter commit messages it's a pity to have 2 newlines for 3 lines of content. I agree that it's important to follow a specification for the commits, but if only the commits were pretty to look at as well!

from git-cm.

mainrs avatar mainrs commented on June 15, 2024

So I have thinking about this for a while and I will probably include a compact version of the current template without the new lines. However, the help screen will have a note that it is not compliant with the specification.

from git-cm.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.