GithubHelp home page GithubHelp logo

conventional-commit-types's Introduction

conventional-commit-types

npm Build Status

List of conventional commit types.

Spec

Exports an object with a types key whose value is an object whose keys are type names and whose values are objects with key-value pairs such as description as string, optional title as string, etc. See index.json. Any alternatives should follow the same spec.

Etc.

Used by commitizen/cz-conventional-changelog for commitizen/cz-cli.

Can be used with kentcdodds/validate-commit-msg.

Commit types originally from:

Created for AndersDJohnson/conventional-commit-types-cli.

conventional-commit-types's People

Contributors

andersdjohnson avatar binarylogic avatar kahboom avatar sno2 avatar stevemao avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

conventional-commit-types's Issues

Suggestion - add ver / version

Sometimes we commit with just the version change. I think just changing version number does not fall under either fix or feat. So I feel like we should have a separate ver for just version changes?

Clarify position of security category

It's not clear from the descriptions of the categories whether security fixes are a bug, enhancement, or chore, or possibly a new category to be added.

suggestion; add enh / enhancement

We have feat for "a new feature" and fix for "a bug fix". But what when we improve the user experience of an existing feature? Shouldn't that be enh or enhancement?

refactor focusses too much on the code. So I feel like some commits don't really fit the suggested types.

Support Breaking Change

Add support for Breaking Change PRs. Currently we are working around this with chore(breaking) however we'd like to format our titles like breaking change: or breaking similar to the docs outlined here or even (major version bump`.

Website?

Hi friends,

thanks for clarifying the different types of commits!

Without using your tools, is there a website or a cheatsheet introducing the conventional commit types in a readable way for humans?

I couldn't find one nor find a link in the repo(s)

Thanks!

add example/demo type?

for a front-end project, it's common to have some (simple)demo live inside the project.
adding a related type to it would be great

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.