Giter Club home page Giter Club logo

conventionalcommits's Introduction

Conventional Commits

This repo demonstrates..

  • The use of Conventional Commits to improve readability for your commit messages, and to make automations based on them. See the commits for examples
  • Commitzen, a tool for git bash that helps you write conventional commit messages
  • Standard version, a tool that uses conventional commits for automatically:
    • Increase the version of your app
    • Create a github release
    • Create a CHANGELOG.md file in your repo that contains a list all features and fixes

How i made this repo: TLDR

Create an empty repo

  • Add a .gitignore-file (see ours)

Add commitizen

  • Added a basic package.json file to hold the version
    • { "name": "conventionalcommits", "version": "0.0.0" }
  • Installed commitizen globally by running
    • npm install -g commitizen
  • Enabled commitizen in the repo by running:
    • commitizen init cz-conventional-changelog --save-dev --save-exact

Automatically generate release and release notes when changes are made to main branch

See the .github/workflows/release.yml file for a github action that uses standard-version to bump the version, create a release and release notes

Sources

conventionalcommits's People

Contributors

krsteen avatar

Watchers

 avatar

conventionalcommits's Issues

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.