cz-freecodecamp

Status:

A plugin for commitizen built for freeCodeCamp

Table of Contents

• Introduction
• Installation
• Usage

Introduction

This Commitizen adapter helps standardize commit messages for freeCodeCamp so being asked to fix incorrectly formatted commit messages will be less of a problem.

Installation

Install as a global adapter for freeCodeCamp repos

# Install the commitizen cli globally
npm install --global commitizen

# Install the freeCodeCamp commitizen adapter globally
npm install --global cz-freecodecamp

# Save the adapter into global config
echo '{ "path": "cz-freecodecamp" }' > ~/.czrc

Usage

Usage on freeCodeCamp's repos

... # Make changes

# Stage changes
git add changed-file

# This adapter is bundled in the freeCodeCamp main repo as a dependancy.
# Either use the inbuilt script
npm run commit

# Or alternatively on any of freeCodeCamp's repos including the main repo,
# use git cz instead of git commit
git cz

Note: Please check the contributing guidelines on the main repo for more on usage.