Git Product home page Git Product logo

commit-guidelines's Introduction

commit-guidelines

A demo repository that exemplifies all techniques discussed in the Git commit messages for the bold and the daring article.

Repository 101

This repository contains four tagged versions, each corresponding to a different technique discussed in the article:

  • commit-template
  • husky
  • commitizen-with-conventional-changelog
  • commitizen-with-commitlint

To try out one specific technique just checkout the corresponding tag and you're good to go.

Getting started

Clone the repository:

git clone https://github.com/CarmenPopoviciu/commit-guidelines.git

Change your current working directory to the repository directory:

cd commit-guidelines

Install npm dependencies:

npm install

or

yarn

Checkout the version you're interested in and start playing around (please see below the necessary setup instructions for each available tag)

commit-template

Checkout the commit-template tag:

git checkout commit-template

Change your local Git configuration to use the example template in the repository (see the .git-message-template file):

git config --local commit.template "path_to/.git-message-template"

Make some changes in the repository and commit them:

git commit

Rejoice \o/

commit-template

husky

Checkout the husky tag:

git checkout husky

Make some changes in the repository and commit them:

git commit

Rejoice some more \o/

husky

commitizen-with-conventional-changelog

Checkout the commitizen-with-conventional-changelog tag:

git checkout commitizen-with-conventional-changelog

Make some changes in the repository and commit them:

npm run commit

or

yarn commit

Happiness FTW

commitizen-with-conventional-changelog

commitizen-with-commitlint

Checkout the commitizen-with-commitlint tag:

git checkout commitizen-with-commitlint

Make some changes in the repository and commit them:

npm run commit

or

yarn commit

Have an ice cream, you deserved it!

commitizen-with-commitlint

commit-guidelines's People

Contributors

carmenpopoviciu avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

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.