cz-freecodecamp

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.

Changelog

1.0.1 (2017-09-04)

Bug Fixes

• index: Prevent stand-alone numbers in title (a3f0f70), closes #18

<a name="1.0.0"></a>

Bug Fixes

• adapter: Fix typo in etc. (39182b8)
• build: Add proper deps, force republish to make sure things are working (922097b)
• build: Automatic releases!!! ✨ (114f967)
• commit: Remove es6 string syntax (backticks) (7f922f2)
• commit: remove parentheses when there is no scope present (55f72b9)
• index: Clarify commit body purpose (10aa420)
• index: Clarify title description question (272f2b4)
• index: Limit subject and body character width (3ecdeca)
• package: change git org name to lowercase (424a254)
• package: update longest to version 2.0.0 (55f0ebc)
• prompter: resolve issue with new inquirer api (#18) (807b4e5)
• require: get rid of relative path to the word-wrap (e98818a), closes #4
• types: Simply types of commit (5f69650)
• wrapping: Fix fields to wrap instead of truncate at 100 characters (c7b7e11), closes commitizen/cz-cli#4

Features

• adapter: Create initial commit. (4e8da01)
• adapter: refactor to engine, default to conventional commit types (c8452d1), closes #29
• adapter: Split breaking changes into separate question (#44) (2d78e1d), closes #17
• index: Auto add closing keyword to commit (cf69aa7)
• index: Capitalize git commit title (0ed12d5)
• index: Prevent issue numbers in commit titles (fcbc608)
• index: Restrict title without end period (ccfd211)

BREAKING CHANGES

• adapter: Breaking changes now automatically include the "BREAKING CHANGE: " prefix.