Commitizen by commitizen

-What is Commitizen?

+Commitizen + +

+About Commitizen

Commitizen is an open source project that helps contributors be good open source citizens. It accomplishes this by prompting them to follow commit message conventions at commit time. It also empowers project maintainers to create or use predefined commit message conventions in their repos to better communicate their expectations to potential contributors.

diff --git a/params.json b/params.json index fd0d1716..8303f57f 100644 --- a/params.json +++ b/params.json @@ -1 +1 @@ -{"name":"Commitizen","tagline":"Simple commit conventions for internet citizens.","body":"### What is Commitizen?\r\nCommitizen is an open source project that helps contributors be good open source citizens. It accomplishes this by prompting them to follow commit message conventions at commit time. It also empowers project maintainers to create or use predefined commit message conventions in their repos to better communicate their expectations to potential contributors.\r\n\r\n#### For contributors\r\nWhen you commit with Commitizen, you'll be prompted to fill out any required commit fields at commit time. No more waiting until later for a git commit hook to run and reject your commit. No more digging through CONTRIBUTING.md to find what the preferred format is. Get instant feedback on your commit message formatting and be prompted for required fields.\r\n\r\n##### Installation\r\nInstallation is as simple as running the following command (add sudo if on OSX/Linux):\r\n\r\n```\r\nnpm install -g commitizen\r\n```\r\n\r\n##### Usage\r\nNow, simply use `git cz` instead of `git commit` when committing. \r\n\r\nWhen you're working in a Commitizen friendly repository, you'll be prompted to fill in any required fields and your commit messages will be formatted according to the the standards defined by project maintainers. If you're not working in a Commitizen friendly repository, then `git cz` will work just the same as `git commit`.\r\n\r\n#### For maintainers\r\nAs a project maintainer, making your repo Commitizen friendly allows you to select pre-existing commit message conventions or to create your own custom commit message convention. When a contributor to your repo uses Commitizen, they will be prompted for the correct fields at commit time. \r\n\r\nGetting started is simple. \r\n\r\nFor this example, we'll be setting up our repo to use [AngularJS's commit message convention](https://github.com/angular/angular.js/blob/master/CONTRIBUTING.md#-git-commit-guidelines) also known as [conventional-changelog](https://github.com/ajoslin/conventional-changelog).\r\n\r\nFirst, install the Commitizen conventional-changelog adapter into your project.\r\n\r\n```\r\nnpm install cz-conventional-changelog\r\n```\r\n\r\nThen just add **.cz.json** to the root of your repository with the following contents:\r\n\r\n```json\r\n{\r\n \"path\": \"node_modules/cz-conventional-changelog/\"\r\n}\r\n```\r\n\r\nThis just tells Commitizen which adapter we actually want our contributors to use when for this repo. Congrats! You've made it much easier for your contributors to be good net citizens! \r\n\r\n##### Philosophy\r\nCommitizen is not meant to be a replacement for git commit hooks. Rather, it is meant to work side-by-side with them to ensure a consistent and positive experience for your contributors. Commitizen treats the commit command as a declarative action. The contributor is declaring that they wish to contribute to your project. It is up to you as the maintainer to define what rules they should be following.\r\n\r\nWe accomplish this by letting you define which adapter you'd like to use in your project. Adapters just allow multiple projects to share the same commit message conventions. A good example of an adapter is the cz-conventional-commit adapter.\r\n\r\n### Authors and Contributors\r\nJim Cummins (@JimTheDev)\r\n","google":"","note":"Don't delete this file! It's used internally to help with page regeneration."} \ No newline at end of file +{"name":"Commitizen","tagline":"Simple commit conventions for internet citizens.","body":"### Commitizen\r\n\r\n#### About Commitizen\r\nCommitizen is an open source project that helps contributors be good open source citizens. It accomplishes this by prompting them to follow commit message conventions at commit time. It also empowers project maintainers to create or use predefined commit message conventions in their repos to better communicate their expectations to potential contributors.\r\n\r\n#### For contributors\r\nWhen you commit with Commitizen, you'll be prompted to fill out any required commit fields at commit time. No more waiting until later for a git commit hook to run and reject your commit. No more digging through CONTRIBUTING.md to find what the preferred format is. Get instant feedback on your commit message formatting and be prompted for required fields.\r\n\r\n##### Installation\r\nInstallation is as simple as running the following command (add sudo if on OSX/Linux):\r\n\r\n```\r\nnpm install -g commitizen\r\n```\r\n\r\n##### Usage\r\nNow, simply use `git cz` instead of `git commit` when committing. \r\n\r\nWhen you're working in a Commitizen friendly repository, you'll be prompted to fill in any required fields and your commit messages will be formatted according to the the standards defined by project maintainers. If you're not working in a Commitizen friendly repository, then `git cz` will work just the same as `git commit`.\r\n\r\n#### For maintainers\r\nAs a project maintainer, making your repo Commitizen friendly allows you to select pre-existing commit message conventions or to create your own custom commit message convention. When a contributor to your repo uses Commitizen, they will be prompted for the correct fields at commit time. \r\n\r\nGetting started is simple. \r\n\r\nFor this example, we'll be setting up our repo to use [AngularJS's commit message convention](https://github.com/angular/angular.js/blob/master/CONTRIBUTING.md#-git-commit-guidelines) also known as [conventional-changelog](https://github.com/ajoslin/conventional-changelog).\r\n\r\nFirst, install the Commitizen conventional-changelog adapter into your project.\r\n\r\n```\r\nnpm install cz-conventional-changelog\r\n```\r\n\r\nThen just add **.cz.json** to the root of your repository with the following contents:\r\n\r\n```json\r\n{\r\n \"path\": \"node_modules/cz-conventional-changelog/\"\r\n}\r\n```\r\n\r\nThis just tells Commitizen which adapter we actually want our contributors to use when for this repo. Congrats! You've made it much easier for your contributors to be good net citizens! \r\n\r\n##### Philosophy\r\nCommitizen is not meant to be a replacement for git commit hooks. Rather, it is meant to work side-by-side with them to ensure a consistent and positive experience for your contributors. Commitizen treats the commit command as a declarative action. The contributor is declaring that they wish to contribute to your project. It is up to you as the maintainer to define what rules they should be following.\r\n\r\nWe accomplish this by letting you define which adapter you'd like to use in your project. Adapters just allow multiple projects to share the same commit message conventions. A good example of an adapter is the cz-conventional-commit adapter.\r\n\r\n### Authors and Contributors\r\nJim Cummins (@JimTheDev)\r\n","google":"","note":"Don't delete this file! It's used internally to help with page regeneration."} \ No newline at end of file From 7a39bf14b08b64b4e062e02aa1912ddcc196a140 Mon Sep 17 00:00:00 2001 From: Jim Cummins Date: Mon, 20 Apr 2015 10:56:54 -0500 Subject: [PATCH 03/12] Create gh-pages branch via GitHub --- index.html | 25 +++++++++++-------------- params.json | 2 +- 2 files changed, 12 insertions(+), 15 deletions(-) diff --git a/index.html b/index.html index e9eb3362..e931dd54 100644 --- a/index.html +++ b/index.html @@ -32,35 +32,32 @@

Simple commit conventions for internet citizens.

-Commitizen

- -

-About Commitizen

+About Commitizen

-For contributors

+Commitizen for contributors

When you commit with Commitizen, you'll be prompted to fill out any required commit fields at commit time. No more waiting until later for a git commit hook to run and reject your commit. No more digging through CONTRIBUTING.md to find what the preferred format is. Get instant feedback on your commit message formatting and be prompted for required fields.

-Installation

+Installation

Installation is as simple as running the following command (add sudo if on OSX/Linux):

npm install -g commitizen

-Usage

+Usage

Now, simply use git cz instead of git commit when committing.

When you're working in a Commitizen friendly repository, you'll be prompted to fill in any required fields and your commit messages will be formatted according to the the standards defined by project maintainers. If you're not working in a Commitizen friendly repository, then git cz will work just the same as git commit.

-For maintainers

+Commitizen for maintainers

As a project maintainer, making your repo Commitizen friendly allows you to select pre-existing commit message conventions or to create your own custom commit message convention. When a contributor to your repo uses Commitizen, they will be prompted for the correct fields at commit time.

@@ -81,8 +78,8 @@

This just tells Commitizen which adapter we actually want our contributors to use when for this repo. Congrats! You've made it much easier for your contributors to be good net citizens!
-

-Philosophy

+Philosophy

Commitizen is not meant to be a replacement for git commit hooks. Rather, it is meant to work side-by-side with them to ensure a consistent and positive experience for your contributors. Commitizen treats the commit command as a declarative action. The contributor is declaring that they wish to contribute to your project. It is up to you as the maintainer to define what rules they should be following.

diff --git a/params.json b/params.json index 8303f57f..80ec0af2 100644 --- a/params.json +++ b/params.json @@ -1 +1 @@ -{"name":"Commitizen","tagline":"Simple commit conventions for internet citizens.","body":"### Commitizen\r\n\r\n#### About Commitizen\r\nCommitizen is an open source project that helps contributors be good open source citizens. It accomplishes this by prompting them to follow commit message conventions at commit time. It also empowers project maintainers to create or use predefined commit message conventions in their repos to better communicate their expectations to potential contributors.\r\n\r\n#### For contributors\r\nWhen you commit with Commitizen, you'll be prompted to fill out any required commit fields at commit time. No more waiting until later for a git commit hook to run and reject your commit. No more digging through CONTRIBUTING.md to find what the preferred format is. Get instant feedback on your commit message formatting and be prompted for required fields.\r\n\r\n##### Installation\r\nInstallation is as simple as running the following command (add sudo if on OSX/Linux):\r\n\r\n```\r\nnpm install -g commitizen\r\n```\r\n\r\n##### Usage\r\nNow, simply use `git cz` instead of `git commit` when committing. \r\n\r\nWhen you're working in a Commitizen friendly repository, you'll be prompted to fill in any required fields and your commit messages will be formatted according to the the standards defined by project maintainers. If you're not working in a Commitizen friendly repository, then `git cz` will work just the same as `git commit`.\r\n\r\n#### For maintainers\r\nAs a project maintainer, making your repo Commitizen friendly allows you to select pre-existing commit message conventions or to create your own custom commit message convention. When a contributor to your repo uses Commitizen, they will be prompted for the correct fields at commit time. \r\n\r\nGetting started is simple. \r\n\r\nFor this example, we'll be setting up our repo to use [AngularJS's commit message convention](https://github.com/angular/angular.js/blob/master/CONTRIBUTING.md#-git-commit-guidelines) also known as [conventional-changelog](https://github.com/ajoslin/conventional-changelog).\r\n\r\nFirst, install the Commitizen conventional-changelog adapter into your project.\r\n\r\n```\r\nnpm install cz-conventional-changelog\r\n```\r\n\r\nThen just add **.cz.json** to the root of your repository with the following contents:\r\n\r\n```json\r\n{\r\n \"path\": \"node_modules/cz-conventional-changelog/\"\r\n}\r\n```\r\n\r\nThis just tells Commitizen which adapter we actually want our contributors to use when for this repo. Congrats! You've made it much easier for your contributors to be good net citizens! \r\n\r\n##### Philosophy\r\nCommitizen is not meant to be a replacement for git commit hooks. Rather, it is meant to work side-by-side with them to ensure a consistent and positive experience for your contributors. Commitizen treats the commit command as a declarative action. The contributor is declaring that they wish to contribute to your project. It is up to you as the maintainer to define what rules they should be following.\r\n\r\nWe accomplish this by letting you define which adapter you'd like to use in your project. Adapters just allow multiple projects to share the same commit message conventions. A good example of an adapter is the cz-conventional-commit adapter.\r\n\r\n### Authors and Contributors\r\nJim Cummins (@JimTheDev)\r\n","google":"","note":"Don't delete this file! It's used internally to help with page regeneration."} \ No newline at end of file +{"name":"Commitizen","tagline":"Simple commit conventions for internet citizens.","body":"### About Commitizen\r\nCommitizen is an open source project that helps contributors be good open source citizens. It accomplishes this by prompting them to follow commit message conventions at commit time. It also empowers project maintainers to create or use predefined commit message conventions in their repos to better communicate their expectations to potential contributors.\r\n\r\n### Commitizen for contributors\r\nWhen you commit with Commitizen, you'll be prompted to fill out any required commit fields at commit time. No more waiting until later for a git commit hook to run and reject your commit. No more digging through CONTRIBUTING.md to find what the preferred format is. Get instant feedback on your commit message formatting and be prompted for required fields.\r\n\r\n#### Installation\r\nInstallation is as simple as running the following command (add sudo if on OSX/Linux):\r\n\r\n```\r\nnpm install -g commitizen\r\n```\r\n\r\n#### Usage\r\nNow, simply use `git cz` instead of `git commit` when committing. \r\n\r\nWhen you're working in a Commitizen friendly repository, you'll be prompted to fill in any required fields and your commit messages will be formatted according to the the standards defined by project maintainers. If you're not working in a Commitizen friendly repository, then `git cz` will work just the same as `git commit`.\r\n\r\n### Commitizen for maintainers\r\nAs a project maintainer, making your repo Commitizen friendly allows you to select pre-existing commit message conventions or to create your own custom commit message convention. When a contributor to your repo uses Commitizen, they will be prompted for the correct fields at commit time. \r\n\r\nGetting started is simple. \r\n\r\nFor this example, we'll be setting up our repo to use [AngularJS's commit message convention](https://github.com/angular/angular.js/blob/master/CONTRIBUTING.md#-git-commit-guidelines) also known as [conventional-changelog](https://github.com/ajoslin/conventional-changelog).\r\n\r\nFirst, install the Commitizen conventional-changelog adapter into your project.\r\n\r\n```\r\nnpm install cz-conventional-changelog\r\n```\r\n\r\nThen just add **.cz.json** to the root of your repository with the following contents:\r\n\r\n```json\r\n{\r\n \"path\": \"node_modules/cz-conventional-changelog/\"\r\n}\r\n```\r\n\r\nThis just tells Commitizen which adapter we actually want our contributors to use when for this repo. Congrats! You've made it much easier for your contributors to be good net citizens! \r\n\r\n#### Philosophy\r\nCommitizen is not meant to be a replacement for git commit hooks. Rather, it is meant to work side-by-side with them to ensure a consistent and positive experience for your contributors. Commitizen treats the commit command as a declarative action. The contributor is declaring that they wish to contribute to your project. It is up to you as the maintainer to define what rules they should be following.\r\n\r\nWe accomplish this by letting you define which adapter you'd like to use in your project. Adapters just allow multiple projects to share the same commit message conventions. A good example of an adapter is the cz-conventional-commit adapter.\r\n\r\n### Authors and Contributors\r\nJim Cummins (@JimTheDev)\r\n","google":"","note":"Don't delete this file! It's used internally to help with page regeneration."} \ No newline at end of file From d9c8c74c8b20f4972e3c4aeb095234ad25d53858 Mon Sep 17 00:00:00 2001 From: Jim Cummins Date: Mon, 20 Apr 2015 11:11:08 -0500 Subject: [PATCH 04/12] Create gh-pages branch via GitHub --- index.html | 15 +++++++++------ params.json | 2 +- 2 files changed, 10 insertions(+), 7 deletions(-) diff --git a/index.html b/index.html index e931dd54..ea2f5f7a 100644 --- a/index.html +++ b/index.html @@ -32,11 +32,6 @@

Simple commit conventions for internet citizens.

-About Commitizen

- -

Commitizen for contributors

@@ -81,7 +76,15 @@

Philosophy

+About Commitizen

+ +

+Commitizen or Commit Hooks

+ +

Both! Commitizen is not meant to be a replacement for git commit hooks. Rather, it is meant to work side-by-side with them to ensure a consistent and positive experience for your contributors. Commitizen treats the commit command as a declarative action. The contributor is declaring that they wish to contribute to your project. It is up to you as the maintainer to define what rules they should be following.

We accomplish this by letting you define which adapter you'd like to use in your project. Adapters just allow multiple projects to share the same commit message conventions. A good example of an adapter is the cz-conventional-commit adapter.

diff --git a/params.json b/params.json index 80ec0af2..debbd5c5 100644 --- a/params.json +++ b/params.json @@ -1 +1 @@ -{"name":"Commitizen","tagline":"Simple commit conventions for internet citizens.","body":"### About Commitizen\r\nCommitizen is an open source project that helps contributors be good open source citizens. It accomplishes this by prompting them to follow commit message conventions at commit time. It also empowers project maintainers to create or use predefined commit message conventions in their repos to better communicate their expectations to potential contributors.\r\n\r\n### Commitizen for contributors\r\nWhen you commit with Commitizen, you'll be prompted to fill out any required commit fields at commit time. No more waiting until later for a git commit hook to run and reject your commit. No more digging through CONTRIBUTING.md to find what the preferred format is. Get instant feedback on your commit message formatting and be prompted for required fields.\r\n\r\n#### Installation\r\nInstallation is as simple as running the following command (add sudo if on OSX/Linux):\r\n\r\n```\r\nnpm install -g commitizen\r\n```\r\n\r\n#### Usage\r\nNow, simply use `git cz` instead of `git commit` when committing. \r\n\r\nWhen you're working in a Commitizen friendly repository, you'll be prompted to fill in any required fields and your commit messages will be formatted according to the the standards defined by project maintainers. If you're not working in a Commitizen friendly repository, then `git cz` will work just the same as `git commit`.\r\n\r\n### Commitizen for maintainers\r\nAs a project maintainer, making your repo Commitizen friendly allows you to select pre-existing commit message conventions or to create your own custom commit message convention. When a contributor to your repo uses Commitizen, they will be prompted for the correct fields at commit time. \r\n\r\nGetting started is simple. \r\n\r\nFor this example, we'll be setting up our repo to use [AngularJS's commit message convention](https://github.com/angular/angular.js/blob/master/CONTRIBUTING.md#-git-commit-guidelines) also known as [conventional-changelog](https://github.com/ajoslin/conventional-changelog).\r\n\r\nFirst, install the Commitizen conventional-changelog adapter into your project.\r\n\r\n```\r\nnpm install cz-conventional-changelog\r\n```\r\n\r\nThen just add **.cz.json** to the root of your repository with the following contents:\r\n\r\n```json\r\n{\r\n \"path\": \"node_modules/cz-conventional-changelog/\"\r\n}\r\n```\r\n\r\nThis just tells Commitizen which adapter we actually want our contributors to use when for this repo. Congrats! You've made it much easier for your contributors to be good net citizens! \r\n\r\n#### Philosophy\r\nCommitizen is not meant to be a replacement for git commit hooks. Rather, it is meant to work side-by-side with them to ensure a consistent and positive experience for your contributors. Commitizen treats the commit command as a declarative action. The contributor is declaring that they wish to contribute to your project. It is up to you as the maintainer to define what rules they should be following.\r\n\r\nWe accomplish this by letting you define which adapter you'd like to use in your project. Adapters just allow multiple projects to share the same commit message conventions. A good example of an adapter is the cz-conventional-commit adapter.\r\n\r\n### Authors and Contributors\r\nJim Cummins (@JimTheDev)\r\n","google":"","note":"Don't delete this file! It's used internally to help with page regeneration."} \ No newline at end of file +{"name":"Commitizen","tagline":"Simple commit conventions for internet citizens.","body":"### Commitizen for contributors\r\nWhen you commit with Commitizen, you'll be prompted to fill out any required commit fields at commit time. No more waiting until later for a git commit hook to run and reject your commit. No more digging through CONTRIBUTING.md to find what the preferred format is. Get instant feedback on your commit message formatting and be prompted for required fields.\r\n\r\n#### Installation\r\nInstallation is as simple as running the following command (add sudo if on OSX/Linux):\r\n\r\n```\r\nnpm install -g commitizen\r\n```\r\n\r\n#### Usage\r\nNow, simply use `git cz` instead of `git commit` when committing. \r\n\r\nWhen you're working in a Commitizen friendly repository, you'll be prompted to fill in any required fields and your commit messages will be formatted according to the the standards defined by project maintainers. If you're not working in a Commitizen friendly repository, then `git cz` will work just the same as `git commit`.\r\n\r\n### Commitizen for maintainers\r\nAs a project maintainer, making your repo Commitizen friendly allows you to select pre-existing commit message conventions or to create your own custom commit message convention. When a contributor to your repo uses Commitizen, they will be prompted for the correct fields at commit time. \r\n\r\nGetting started is simple. \r\n\r\nFor this example, we'll be setting up our repo to use [AngularJS's commit message convention](https://github.com/angular/angular.js/blob/master/CONTRIBUTING.md#-git-commit-guidelines) also known as [conventional-changelog](https://github.com/ajoslin/conventional-changelog).\r\n\r\nFirst, install the Commitizen conventional-changelog adapter into your project.\r\n\r\n```\r\nnpm install cz-conventional-changelog\r\n```\r\n\r\nThen just add **.cz.json** to the root of your repository with the following contents:\r\n\r\n```json\r\n{\r\n \"path\": \"node_modules/cz-conventional-changelog/\"\r\n}\r\n```\r\n\r\nThis just tells Commitizen which adapter we actually want our contributors to use when for this repo. Congrats! You've made it much easier for your contributors to be good net citizens! \r\n\r\n#### Philosophy\r\n\r\n##### About Commitizen\r\nCommitizen is an open source project that helps contributors be good open source citizens. It accomplishes this by prompting them to follow commit message conventions at commit time. It also empowers project maintainers to create or use predefined commit message conventions in their repos to better communicate their expectations to potential contributors.\r\n\r\n##### Commitizen or Commit Hooks\r\nBoth! Commitizen is not meant to be a replacement for git commit hooks. Rather, it is meant to work side-by-side with them to ensure a consistent and positive experience for your contributors. Commitizen treats the commit command as a declarative action. The contributor is declaring that they wish to contribute to your project. It is up to you as the maintainer to define what rules they should be following.\r\n\r\nWe accomplish this by letting you define which adapter you'd like to use in your project. Adapters just allow multiple projects to share the same commit message conventions. A good example of an adapter is the cz-conventional-commit adapter.\r\n\r\n### Authors and Contributors\r\nJim Cummins (@JimTheDev)\r\n","google":"","note":"Don't delete this file! It's used internally to help with page regeneration."} \ No newline at end of file From fcca81cf6828c4cae4254da1822cf4c4eb60c80b Mon Sep 17 00:00:00 2001 From: Jim Cummins Date: Mon, 20 Apr 2015 11:27:07 -0500 Subject: [PATCH 05/12] Create gh-pages branch via GitHub --- index.html | 21 +++++++++++++++++---- params.json | 2 +- 2 files changed, 18 insertions(+), 5 deletions(-) diff --git a/index.html b/index.html index ea2f5f7a..3ce37653 100644 --- a/index.html +++ b/index.html @@ -37,7 +37,7 @@

When you commit with Commitizen, you'll be prompted to fill out any required commit fields at commit time. No more waiting until later for a git commit hook to run and reject your commit. No more digging through CONTRIBUTING.md to find what the preferred format is. Get instant feedback on your commit message formatting and be prompted for required fields.

-Installation

+Installing the command line tool

Installation is as simple as running the following command (add sudo if on OSX/Linux):

@@ -45,18 +45,19 @@

-Usage

+Using the command line tool

Now, simply use git cz instead of git commit when committing.

-Commitizen for maintainers

+Commitizen for project maintainers

Getting started is simple.

+Making your repo Commitizen-friendly

For this example, we'll be setting up our repo to use AngularJS's commit message convention also known as conventional-changelog.

@@ -73,6 +74,18 @@

This just tells Commitizen which adapter we actually want our contributors to use when for this repo. Congrats! You've made it much easier for your contributors to be good net citizens!
+

+You're Commitizen-friendly. Time to flaunt it!

+ +

Add the Commitizen-friendly badge to your README using the following markdown:

+ +

[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)
+

+ +

It may also make sense to change your README.md or CONTRIBUTING.md to include or link to the Commitizen project so that your new contributors may learn more about installing and using Commitizen.

Philosophy

diff --git a/params.json b/params.json index debbd5c5..902f2950 100644 --- a/params.json +++ b/params.json @@ -1 +1 @@ -{"name":"Commitizen","tagline":"Simple commit conventions for internet citizens.","body":"### Commitizen for contributors\r\nWhen you commit with Commitizen, you'll be prompted to fill out any required commit fields at commit time. No more waiting until later for a git commit hook to run and reject your commit. No more digging through CONTRIBUTING.md to find what the preferred format is. Get instant feedback on your commit message formatting and be prompted for required fields.\r\n\r\n#### Installation\r\nInstallation is as simple as running the following command (add sudo if on OSX/Linux):\r\n\r\n```\r\nnpm install -g commitizen\r\n```\r\n\r\n#### Usage\r\nNow, simply use `git cz` instead of `git commit` when committing. \r\n\r\nWhen you're working in a Commitizen friendly repository, you'll be prompted to fill in any required fields and your commit messages will be formatted according to the the standards defined by project maintainers. If you're not working in a Commitizen friendly repository, then `git cz` will work just the same as `git commit`.\r\n\r\n### Commitizen for maintainers\r\nAs a project maintainer, making your repo Commitizen friendly allows you to select pre-existing commit message conventions or to create your own custom commit message convention. When a contributor to your repo uses Commitizen, they will be prompted for the correct fields at commit time. \r\n\r\nGetting started is simple. \r\n\r\nFor this example, we'll be setting up our repo to use [AngularJS's commit message convention](https://github.com/angular/angular.js/blob/master/CONTRIBUTING.md#-git-commit-guidelines) also known as [conventional-changelog](https://github.com/ajoslin/conventional-changelog).\r\n\r\nFirst, install the Commitizen conventional-changelog adapter into your project.\r\n\r\n```\r\nnpm install cz-conventional-changelog\r\n```\r\n\r\nThen just add **.cz.json** to the root of your repository with the following contents:\r\n\r\n```json\r\n{\r\n \"path\": \"node_modules/cz-conventional-changelog/\"\r\n}\r\n```\r\n\r\nThis just tells Commitizen which adapter we actually want our contributors to use when for this repo. Congrats! You've made it much easier for your contributors to be good net citizens! \r\n\r\n#### Philosophy\r\n\r\n##### About Commitizen\r\nCommitizen is an open source project that helps contributors be good open source citizens. It accomplishes this by prompting them to follow commit message conventions at commit time. It also empowers project maintainers to create or use predefined commit message conventions in their repos to better communicate their expectations to potential contributors.\r\n\r\n##### Commitizen or Commit Hooks\r\nBoth! Commitizen is not meant to be a replacement for git commit hooks. Rather, it is meant to work side-by-side with them to ensure a consistent and positive experience for your contributors. Commitizen treats the commit command as a declarative action. The contributor is declaring that they wish to contribute to your project. It is up to you as the maintainer to define what rules they should be following.\r\n\r\nWe accomplish this by letting you define which adapter you'd like to use in your project. Adapters just allow multiple projects to share the same commit message conventions. A good example of an adapter is the cz-conventional-commit adapter.\r\n\r\n### Authors and Contributors\r\nJim Cummins (@JimTheDev)\r\n","google":"","note":"Don't delete this file! It's used internally to help with page regeneration."} \ No newline at end of file +{"name":"Commitizen","tagline":"Simple commit conventions for internet citizens.","body":"### Commitizen for contributors\r\nWhen you commit with Commitizen, you'll be prompted to fill out any required commit fields at commit time. No more waiting until later for a git commit hook to run and reject your commit. No more digging through CONTRIBUTING.md to find what the preferred format is. Get instant feedback on your commit message formatting and be prompted for required fields.\r\n\r\n#### Installing the command line tool\r\nInstallation is as simple as running the following command (add sudo if on OSX/Linux):\r\n\r\n```\r\nnpm install -g commitizen\r\n```\r\n\r\n#### Using the command line tool\r\nNow, simply use `git cz` instead of `git commit` when committing. \r\n\r\nWhen you're working in a Commitizen friendly repository, you'll be prompted to fill in any required fields and your commit messages will be formatted according to the the standards defined by project maintainers. If you're not working in a Commitizen friendly repository, then `git cz` will work just the same as `git commit`.\r\n\r\n### Commitizen for project maintainers\r\nAs a project maintainer, making your repo Commitizen friendly allows you to select pre-existing commit message conventions or to create your own custom commit message convention. When a contributor to your repo uses Commitizen, they will be prompted for the correct fields at commit time. \r\n\r\n#### Making your repo Commitizen-friendly\r\n\r\nFor this example, we'll be setting up our repo to use [AngularJS's commit message convention](https://github.com/angular/angular.js/blob/master/CONTRIBUTING.md#-git-commit-guidelines) also known as [conventional-changelog](https://github.com/ajoslin/conventional-changelog).\r\n\r\nFirst, install the Commitizen conventional-changelog adapter into your project.\r\n\r\n```\r\nnpm install cz-conventional-changelog\r\n```\r\n\r\nThen just add **.cz.json** to the root of your repository with the following contents:\r\n\r\n```json\r\n{\r\n \"path\": \"node_modules/cz-conventional-changelog/\"\r\n}\r\n```\r\n\r\nThis just tells Commitizen which adapter we actually want our contributors to use when for this repo. Congrats! You've made it much easier for your contributors to be good net citizens! \r\n\r\n#### You're Commitizen-friendly. Time to flaunt it!\r\n\r\n[![Commitizen-friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)\r\n\r\nAdd the Commitizen-friendly badge to your README using the following markdown:\r\n```\r\n[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)\r\n```\r\n\r\nIt may also make sense to change your README.md or CONTRIBUTING.md to include or link to the Commitizen project so that your new contributors may learn more about installing and using Commitizen.\r\n\r\n#### Philosophy\r\n\r\n##### About Commitizen\r\nCommitizen is an open source project that helps contributors be good open source citizens. It accomplishes this by prompting them to follow commit message conventions at commit time. It also empowers project maintainers to create or use predefined commit message conventions in their repos to better communicate their expectations to potential contributors.\r\n\r\n##### Commitizen or Commit Hooks\r\nBoth! Commitizen is not meant to be a replacement for git commit hooks. Rather, it is meant to work side-by-side with them to ensure a consistent and positive experience for your contributors. Commitizen treats the commit command as a declarative action. The contributor is declaring that they wish to contribute to your project. It is up to you as the maintainer to define what rules they should be following.\r\n\r\nWe accomplish this by letting you define which adapter you'd like to use in your project. Adapters just allow multiple projects to share the same commit message conventions. A good example of an adapter is the cz-conventional-commit adapter.\r\n\r\n### Authors and Contributors\r\nJim Cummins (@JimTheDev)","google":"","note":"Don't delete this file! It's used internally to help with page regeneration."} \ No newline at end of file From fb85daf2bb26f25f74df03334f446857047eb691 Mon Sep 17 00:00:00 2001 From: Jim Cummins Date: Mon, 20 Apr 2015 11:30:56 -0500 Subject: [PATCH 06/12] Create gh-pages branch via GitHub --- index.html | 7 ++++--- params.json | 2 +- 2 files changed, 5 insertions(+), 4 deletions(-) diff --git a/index.html b/index.html index 3ce37653..809041cd 100644 --- a/index.html +++ b/index.html @@ -75,15 +75,16 @@

This just tells Commitizen which adapter we actually want our contributors to use when for this repo. Congrats! You've made it much easier for your contributors to be good net citizens!

-You're Commitizen-friendly. Time to flaunt it!

- -

+Congratulations your repo is Commitizen-friendly. Time to flaunt it!

Add the Commitizen-friendly badge to your README using the following markdown:

[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)

It will look like this: +

It may also make sense to change your README.md or CONTRIBUTING.md to include or link to the Commitizen project so that your new contributors may learn more about installing and using Commitizen.

diff --git a/params.json b/params.json index 902f2950..8bdda34a 100644 --- a/params.json +++ b/params.json @@ -1 +1 @@ -{"name":"Commitizen","tagline":"Simple commit conventions for internet citizens.","body":"### Commitizen for contributors\r\nWhen you commit with Commitizen, you'll be prompted to fill out any required commit fields at commit time. No more waiting until later for a git commit hook to run and reject your commit. No more digging through CONTRIBUTING.md to find what the preferred format is. Get instant feedback on your commit message formatting and be prompted for required fields.\r\n\r\n#### Installing the command line tool\r\nInstallation is as simple as running the following command (add sudo if on OSX/Linux):\r\n\r\n```\r\nnpm install -g commitizen\r\n```\r\n\r\n#### Using the command line tool\r\nNow, simply use `git cz` instead of `git commit` when committing. \r\n\r\nWhen you're working in a Commitizen friendly repository, you'll be prompted to fill in any required fields and your commit messages will be formatted according to the the standards defined by project maintainers. If you're not working in a Commitizen friendly repository, then `git cz` will work just the same as `git commit`.\r\n\r\n### Commitizen for project maintainers\r\nAs a project maintainer, making your repo Commitizen friendly allows you to select pre-existing commit message conventions or to create your own custom commit message convention. When a contributor to your repo uses Commitizen, they will be prompted for the correct fields at commit time. \r\n\r\n#### Making your repo Commitizen-friendly\r\n\r\nFor this example, we'll be setting up our repo to use [AngularJS's commit message convention](https://github.com/angular/angular.js/blob/master/CONTRIBUTING.md#-git-commit-guidelines) also known as [conventional-changelog](https://github.com/ajoslin/conventional-changelog).\r\n\r\nFirst, install the Commitizen conventional-changelog adapter into your project.\r\n\r\n```\r\nnpm install cz-conventional-changelog\r\n```\r\n\r\nThen just add **.cz.json** to the root of your repository with the following contents:\r\n\r\n```json\r\n{\r\n \"path\": \"node_modules/cz-conventional-changelog/\"\r\n}\r\n```\r\n\r\nThis just tells Commitizen which adapter we actually want our contributors to use when for this repo. Congrats! You've made it much easier for your contributors to be good net citizens! \r\n\r\n#### You're Commitizen-friendly. Time to flaunt it!\r\n\r\n[![Commitizen-friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)\r\n\r\nAdd the Commitizen-friendly badge to your README using the following markdown:\r\n```\r\n[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)\r\n```\r\n\r\nIt may also make sense to change your README.md or CONTRIBUTING.md to include or link to the Commitizen project so that your new contributors may learn more about installing and using Commitizen.\r\n\r\n#### Philosophy\r\n\r\n##### About Commitizen\r\nCommitizen is an open source project that helps contributors be good open source citizens. It accomplishes this by prompting them to follow commit message conventions at commit time. It also empowers project maintainers to create or use predefined commit message conventions in their repos to better communicate their expectations to potential contributors.\r\n\r\n##### Commitizen or Commit Hooks\r\nBoth! Commitizen is not meant to be a replacement for git commit hooks. Rather, it is meant to work side-by-side with them to ensure a consistent and positive experience for your contributors. Commitizen treats the commit command as a declarative action. The contributor is declaring that they wish to contribute to your project. It is up to you as the maintainer to define what rules they should be following.\r\n\r\nWe accomplish this by letting you define which adapter you'd like to use in your project. Adapters just allow multiple projects to share the same commit message conventions. A good example of an adapter is the cz-conventional-commit adapter.\r\n\r\n### Authors and Contributors\r\nJim Cummins (@JimTheDev)","google":"","note":"Don't delete this file! It's used internally to help with page regeneration."} \ No newline at end of file +{"name":"Commitizen","tagline":"Simple commit conventions for internet citizens.","body":"### Commitizen for contributors\r\nWhen you commit with Commitizen, you'll be prompted to fill out any required commit fields at commit time. No more waiting until later for a git commit hook to run and reject your commit. No more digging through CONTRIBUTING.md to find what the preferred format is. Get instant feedback on your commit message formatting and be prompted for required fields.\r\n\r\n#### Installing the command line tool\r\nInstallation is as simple as running the following command (add sudo if on OSX/Linux):\r\n\r\n```\r\nnpm install -g commitizen\r\n```\r\n\r\n#### Using the command line tool\r\nNow, simply use `git cz` instead of `git commit` when committing. \r\n\r\nWhen you're working in a Commitizen friendly repository, you'll be prompted to fill in any required fields and your commit messages will be formatted according to the the standards defined by project maintainers. If you're not working in a Commitizen friendly repository, then `git cz` will work just the same as `git commit`.\r\n\r\n### Commitizen for project maintainers\r\nAs a project maintainer, making your repo Commitizen friendly allows you to select pre-existing commit message conventions or to create your own custom commit message convention. When a contributor to your repo uses Commitizen, they will be prompted for the correct fields at commit time. \r\n\r\n#### Making your repo Commitizen-friendly\r\n\r\nFor this example, we'll be setting up our repo to use [AngularJS's commit message convention](https://github.com/angular/angular.js/blob/master/CONTRIBUTING.md#-git-commit-guidelines) also known as [conventional-changelog](https://github.com/ajoslin/conventional-changelog).\r\n\r\nFirst, install the Commitizen conventional-changelog adapter into your project.\r\n\r\n```\r\nnpm install cz-conventional-changelog\r\n```\r\n\r\nThen just add **.cz.json** to the root of your repository with the following contents:\r\n\r\n```json\r\n{\r\n \"path\": \"node_modules/cz-conventional-changelog/\"\r\n}\r\n```\r\n\r\nThis just tells Commitizen which adapter we actually want our contributors to use when for this repo. Congrats! You've made it much easier for your contributors to be good net citizens! \r\n\r\n#### Congratulations your repo is Commitizen-friendly. Time to flaunt it!\r\n\r\nAdd the Commitizen-friendly badge to your README using the following markdown:\r\n```\r\n[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)\r\n```\r\n\r\nIt will look like this:\r\n[![Commitizen-friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)\r\n\r\nIt may also make sense to change your README.md or CONTRIBUTING.md to include or link to the Commitizen project so that your new contributors may learn more about installing and using Commitizen.\r\n\r\n#### Philosophy\r\n\r\n##### About Commitizen\r\nCommitizen is an open source project that helps contributors be good open source citizens. It accomplishes this by prompting them to follow commit message conventions at commit time. It also empowers project maintainers to create or use predefined commit message conventions in their repos to better communicate their expectations to potential contributors.\r\n\r\n##### Commitizen or Commit Hooks\r\nBoth! Commitizen is not meant to be a replacement for git commit hooks. Rather, it is meant to work side-by-side with them to ensure a consistent and positive experience for your contributors. Commitizen treats the commit command as a declarative action. The contributor is declaring that they wish to contribute to your project. It is up to you as the maintainer to define what rules they should be following.\r\n\r\nWe accomplish this by letting you define which adapter you'd like to use in your project. Adapters just allow multiple projects to share the same commit message conventions. A good example of an adapter is the cz-conventional-commit adapter.\r\n\r\n### Authors and Contributors\r\nJim Cummins (@JimTheDev)","google":"","note":"Don't delete this file! It's used internally to help with page regeneration."} \ No newline at end of file From 993012b71ef1e0c44cab15b7aa88c28455c95878 Mon Sep 17 00:00:00 2001 From: Jim Cummins Date: Mon, 20 Apr 2015 11:35:03 -0500 Subject: [PATCH 07/12] Create gh-pages branch via GitHub --- index.html | 12 ++++++------ params.json | 2 +- 2 files changed, 7 insertions(+), 7 deletions(-) diff --git a/index.html b/index.html index 809041cd..8c86d54e 100644 --- a/index.html +++ b/index.html @@ -87,16 +87,16 @@

It may also make sense to change your README.md or CONTRIBUTING.md to include or link to the Commitizen project so that your new contributors may learn more about installing and using Commitizen.
-

-Philosophy

+Philosophy

-About Commitizen

+About Commitizen

-Commitizen or Commit Hooks

+Commitizen or Commit Hooks

diff --git a/params.json b/params.json index 8bdda34a..be53285f 100644 --- a/params.json +++ b/params.json @@ -1 +1 @@ -{"name":"Commitizen","tagline":"Simple commit conventions for internet citizens.","body":"### Commitizen for contributors\r\nWhen you commit with Commitizen, you'll be prompted to fill out any required commit fields at commit time. No more waiting until later for a git commit hook to run and reject your commit. No more digging through CONTRIBUTING.md to find what the preferred format is. Get instant feedback on your commit message formatting and be prompted for required fields.\r\n\r\n#### Installing the command line tool\r\nInstallation is as simple as running the following command (add sudo if on OSX/Linux):\r\n\r\n```\r\nnpm install -g commitizen\r\n```\r\n\r\n#### Using the command line tool\r\nNow, simply use `git cz` instead of `git commit` when committing. \r\n\r\nWhen you're working in a Commitizen friendly repository, you'll be prompted to fill in any required fields and your commit messages will be formatted according to the the standards defined by project maintainers. If you're not working in a Commitizen friendly repository, then `git cz` will work just the same as `git commit`.\r\n\r\n### Commitizen for project maintainers\r\nAs a project maintainer, making your repo Commitizen friendly allows you to select pre-existing commit message conventions or to create your own custom commit message convention. When a contributor to your repo uses Commitizen, they will be prompted for the correct fields at commit time. \r\n\r\n#### Making your repo Commitizen-friendly\r\n\r\nFor this example, we'll be setting up our repo to use [AngularJS's commit message convention](https://github.com/angular/angular.js/blob/master/CONTRIBUTING.md#-git-commit-guidelines) also known as [conventional-changelog](https://github.com/ajoslin/conventional-changelog).\r\n\r\nFirst, install the Commitizen conventional-changelog adapter into your project.\r\n\r\n```\r\nnpm install cz-conventional-changelog\r\n```\r\n\r\nThen just add **.cz.json** to the root of your repository with the following contents:\r\n\r\n```json\r\n{\r\n \"path\": \"node_modules/cz-conventional-changelog/\"\r\n}\r\n```\r\n\r\nThis just tells Commitizen which adapter we actually want our contributors to use when for this repo. Congrats! You've made it much easier for your contributors to be good net citizens! \r\n\r\n#### Congratulations your repo is Commitizen-friendly. Time to flaunt it!\r\n\r\nAdd the Commitizen-friendly badge to your README using the following markdown:\r\n```\r\n[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)\r\n```\r\n\r\nIt will look like this:\r\n[![Commitizen-friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)\r\n\r\nIt may also make sense to change your README.md or CONTRIBUTING.md to include or link to the Commitizen project so that your new contributors may learn more about installing and using Commitizen.\r\n\r\n#### Philosophy\r\n\r\n##### About Commitizen\r\nCommitizen is an open source project that helps contributors be good open source citizens. It accomplishes this by prompting them to follow commit message conventions at commit time. It also empowers project maintainers to create or use predefined commit message conventions in their repos to better communicate their expectations to potential contributors.\r\n\r\n##### Commitizen or Commit Hooks\r\nBoth! Commitizen is not meant to be a replacement for git commit hooks. Rather, it is meant to work side-by-side with them to ensure a consistent and positive experience for your contributors. Commitizen treats the commit command as a declarative action. The contributor is declaring that they wish to contribute to your project. It is up to you as the maintainer to define what rules they should be following.\r\n\r\nWe accomplish this by letting you define which adapter you'd like to use in your project. Adapters just allow multiple projects to share the same commit message conventions. A good example of an adapter is the cz-conventional-commit adapter.\r\n\r\n### Authors and Contributors\r\nJim Cummins (@JimTheDev)","google":"","note":"Don't delete this file! It's used internally to help with page regeneration."} \ No newline at end of file +{"name":"Commitizen","tagline":"Simple commit conventions for internet citizens.","body":"### Commitizen for contributors\r\nWhen you commit with Commitizen, you'll be prompted to fill out any required commit fields at commit time. No more waiting until later for a git commit hook to run and reject your commit. No more digging through CONTRIBUTING.md to find what the preferred format is. Get instant feedback on your commit message formatting and be prompted for required fields.\r\n\r\n#### Installing the command line tool\r\nInstallation is as simple as running the following command (add sudo if on OSX/Linux):\r\n\r\n```\r\nnpm install -g commitizen\r\n```\r\n\r\n#### Using the command line tool\r\nNow, simply use `git cz` instead of `git commit` when committing. \r\n\r\nWhen you're working in a Commitizen friendly repository, you'll be prompted to fill in any required fields and your commit messages will be formatted according to the the standards defined by project maintainers. If you're not working in a Commitizen friendly repository, then `git cz` will work just the same as `git commit`.\r\n\r\n### Commitizen for project maintainers\r\nAs a project maintainer, making your repo Commitizen friendly allows you to select pre-existing commit message conventions or to create your own custom commit message convention. When a contributor to your repo uses Commitizen, they will be prompted for the correct fields at commit time. \r\n\r\n#### Making your repo Commitizen-friendly\r\n\r\nFor this example, we'll be setting up our repo to use [AngularJS's commit message convention](https://github.com/angular/angular.js/blob/master/CONTRIBUTING.md#-git-commit-guidelines) also known as [conventional-changelog](https://github.com/ajoslin/conventional-changelog).\r\n\r\nFirst, install the Commitizen conventional-changelog adapter into your project.\r\n\r\n```\r\nnpm install cz-conventional-changelog\r\n```\r\n\r\nThen just add **.cz.json** to the root of your repository with the following contents:\r\n\r\n```json\r\n{\r\n \"path\": \"node_modules/cz-conventional-changelog/\"\r\n}\r\n```\r\n\r\nThis just tells Commitizen which adapter we actually want our contributors to use when for this repo. Congrats! You've made it much easier for your contributors to be good net citizens! \r\n\r\n#### Congratulations your repo is Commitizen-friendly. Time to flaunt it!\r\n\r\nAdd the Commitizen-friendly badge to your README using the following markdown:\r\n```\r\n[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)\r\n```\r\n\r\nIt will look like this:\r\n[![Commitizen-friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)\r\n\r\nIt may also make sense to change your README.md or CONTRIBUTING.md to include or link to the Commitizen project so that your new contributors may learn more about installing and using Commitizen.\r\n\r\n### Philosophy\r\n\r\n#### About Commitizen\r\nCommitizen is an open source project that helps contributors be good open source citizens. It accomplishes this by prompting them to follow commit message conventions at commit time. It also empowers project maintainers to create or use predefined commit message conventions in their repos to better communicate their expectations to potential contributors.\r\n\r\n#### Commitizen or Commit Hooks\r\nBoth! Commitizen is not meant to be a replacement for git commit hooks. Rather, it is meant to work side-by-side with them to ensure a consistent and positive experience for your contributors. Commitizen treats the commit command as a declarative action. The contributor is declaring that they wish to contribute to your project. It is up to you as the maintainer to define what rules they should be following.\r\n\r\nWe accomplish this by letting you define which adapter you'd like to use in your project. Adapters just allow multiple projects to share the same commit message conventions. A good example of an adapter is the cz-conventional-commit adapter.\r\n\r\n### Authors and Contributors\r\nJim Cummins (@JimTheDev)","google":"","note":"Don't delete this file! It's used internally to help with page regeneration."} \ No newline at end of file From 68dccc8cfe4a9c82667b5f29a22248b66a6fa87e Mon Sep 17 00:00:00 2001 From: Jim Cummins Date: Mon, 20 Apr 2015 11:36:54 -0500 Subject: [PATCH 08/12] Create gh-pages branch via GitHub --- index.html | 2 +- params.json | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/index.html b/index.html index 8c86d54e..b6d8c9ec 100644 --- a/index.html +++ b/index.html @@ -72,7 +72,7 @@

"path": "node_modules/cz-conventional-changelog/" } -
This just tells Commitizen which adapter we actually want our contributors to use when for this repo. Congrats! You've made it much easier for your contributors to be good net citizens!
+
This just tells Commitizen which adapter we actually want our contributors to use when they try to commit to this repo.

Congratulations your repo is Commitizen-friendly. Time to flaunt it!

diff --git a/params.json b/params.json index be53285f..a79fdce7 100644 --- a/params.json +++ b/params.json @@ -1 +1 @@ -{"name":"Commitizen","tagline":"Simple commit conventions for internet citizens.","body":"### Commitizen for contributors\r\nWhen you commit with Commitizen, you'll be prompted to fill out any required commit fields at commit time. No more waiting until later for a git commit hook to run and reject your commit. No more digging through CONTRIBUTING.md to find what the preferred format is. Get instant feedback on your commit message formatting and be prompted for required fields.\r\n\r\n#### Installing the command line tool\r\nInstallation is as simple as running the following command (add sudo if on OSX/Linux):\r\n\r\n```\r\nnpm install -g commitizen\r\n```\r\n\r\n#### Using the command line tool\r\nNow, simply use `git cz` instead of `git commit` when committing. \r\n\r\nWhen you're working in a Commitizen friendly repository, you'll be prompted to fill in any required fields and your commit messages will be formatted according to the the standards defined by project maintainers. If you're not working in a Commitizen friendly repository, then `git cz` will work just the same as `git commit`.\r\n\r\n### Commitizen for project maintainers\r\nAs a project maintainer, making your repo Commitizen friendly allows you to select pre-existing commit message conventions or to create your own custom commit message convention. When a contributor to your repo uses Commitizen, they will be prompted for the correct fields at commit time. \r\n\r\n#### Making your repo Commitizen-friendly\r\n\r\nFor this example, we'll be setting up our repo to use [AngularJS's commit message convention](https://github.com/angular/angular.js/blob/master/CONTRIBUTING.md#-git-commit-guidelines) also known as [conventional-changelog](https://github.com/ajoslin/conventional-changelog).\r\n\r\nFirst, install the Commitizen conventional-changelog adapter into your project.\r\n\r\n```\r\nnpm install cz-conventional-changelog\r\n```\r\n\r\nThen just add **.cz.json** to the root of your repository with the following contents:\r\n\r\n```json\r\n{\r\n \"path\": \"node_modules/cz-conventional-changelog/\"\r\n}\r\n```\r\n\r\nThis just tells Commitizen which adapter we actually want our contributors to use when for this repo. Congrats! You've made it much easier for your contributors to be good net citizens! \r\n\r\n#### Congratulations your repo is Commitizen-friendly. Time to flaunt it!\r\n\r\nAdd the Commitizen-friendly badge to your README using the following markdown:\r\n```\r\n[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)\r\n```\r\n\r\nIt will look like this:\r\n[![Commitizen-friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)\r\n\r\nIt may also make sense to change your README.md or CONTRIBUTING.md to include or link to the Commitizen project so that your new contributors may learn more about installing and using Commitizen.\r\n\r\n### Philosophy\r\n\r\n#### About Commitizen\r\nCommitizen is an open source project that helps contributors be good open source citizens. It accomplishes this by prompting them to follow commit message conventions at commit time. It also empowers project maintainers to create or use predefined commit message conventions in their repos to better communicate their expectations to potential contributors.\r\n\r\n#### Commitizen or Commit Hooks\r\nBoth! Commitizen is not meant to be a replacement for git commit hooks. Rather, it is meant to work side-by-side with them to ensure a consistent and positive experience for your contributors. Commitizen treats the commit command as a declarative action. The contributor is declaring that they wish to contribute to your project. It is up to you as the maintainer to define what rules they should be following.\r\n\r\nWe accomplish this by letting you define which adapter you'd like to use in your project. Adapters just allow multiple projects to share the same commit message conventions. A good example of an adapter is the cz-conventional-commit adapter.\r\n\r\n### Authors and Contributors\r\nJim Cummins (@JimTheDev)","google":"","note":"Don't delete this file! It's used internally to help with page regeneration."} \ No newline at end of file +{"name":"Commitizen","tagline":"Simple commit conventions for internet citizens.","body":"### Commitizen for contributors\r\nWhen you commit with Commitizen, you'll be prompted to fill out any required commit fields at commit time. No more waiting until later for a git commit hook to run and reject your commit. No more digging through CONTRIBUTING.md to find what the preferred format is. Get instant feedback on your commit message formatting and be prompted for required fields.\r\n\r\n#### Installing the command line tool\r\nInstallation is as simple as running the following command (add sudo if on OSX/Linux):\r\n\r\n```\r\nnpm install -g commitizen\r\n```\r\n\r\n#### Using the command line tool\r\nNow, simply use `git cz` instead of `git commit` when committing. \r\n\r\nWhen you're working in a Commitizen friendly repository, you'll be prompted to fill in any required fields and your commit messages will be formatted according to the the standards defined by project maintainers. If you're not working in a Commitizen friendly repository, then `git cz` will work just the same as `git commit`.\r\n\r\n### Commitizen for project maintainers\r\nAs a project maintainer, making your repo Commitizen friendly allows you to select pre-existing commit message conventions or to create your own custom commit message convention. When a contributor to your repo uses Commitizen, they will be prompted for the correct fields at commit time. \r\n\r\n#### Making your repo Commitizen-friendly\r\n\r\nFor this example, we'll be setting up our repo to use [AngularJS's commit message convention](https://github.com/angular/angular.js/blob/master/CONTRIBUTING.md#-git-commit-guidelines) also known as [conventional-changelog](https://github.com/ajoslin/conventional-changelog).\r\n\r\nFirst, install the Commitizen conventional-changelog adapter into your project.\r\n\r\n```\r\nnpm install cz-conventional-changelog\r\n```\r\n\r\nThen just add **.cz.json** to the root of your repository with the following contents:\r\n\r\n```json\r\n{\r\n \"path\": \"node_modules/cz-conventional-changelog/\"\r\n}\r\n```\r\n\r\nThis just tells Commitizen which adapter we actually want our contributors to use when they try to commit to this repo.\r\n\r\n#### Congratulations your repo is Commitizen-friendly. Time to flaunt it!\r\n\r\nAdd the Commitizen-friendly badge to your README using the following markdown:\r\n```\r\n[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)\r\n```\r\n\r\nIt will look like this:\r\n[![Commitizen-friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)\r\n\r\nIt may also make sense to change your README.md or CONTRIBUTING.md to include or link to the Commitizen project so that your new contributors may learn more about installing and using Commitizen.\r\n\r\n### Philosophy\r\n\r\n#### About Commitizen\r\nCommitizen is an open source project that helps contributors be good open source citizens. It accomplishes this by prompting them to follow commit message conventions at commit time. It also empowers project maintainers to create or use predefined commit message conventions in their repos to better communicate their expectations to potential contributors.\r\n\r\n#### Commitizen or Commit Hooks\r\nBoth! Commitizen is not meant to be a replacement for git commit hooks. Rather, it is meant to work side-by-side with them to ensure a consistent and positive experience for your contributors. Commitizen treats the commit command as a declarative action. The contributor is declaring that they wish to contribute to your project. It is up to you as the maintainer to define what rules they should be following.\r\n\r\nWe accomplish this by letting you define which adapter you'd like to use in your project. Adapters just allow multiple projects to share the same commit message conventions. A good example of an adapter is the cz-conventional-commit adapter.\r\n\r\n### Authors and Contributors\r\nJim Cummins (@JimTheDev)","google":"","note":"Don't delete this file! It's used internally to help with page regeneration."} \ No newline at end of file From c9d11b7f5511d7d3af2515e992253854207d662c Mon Sep 17 00:00:00 2001 From: Jim Cummins Date: Mon, 20 Apr 2015 11:48:05 -0500 Subject: [PATCH 09/12] Create gh-pages branch via GitHub --- index.html | 5 +++-- params.json | 2 +- 2 files changed, 4 insertions(+), 3 deletions(-) diff --git a/index.html b/index.html index b6d8c9ec..0287c1fd 100644 --- a/index.html +++ b/index.html @@ -82,8 +82,9 @@

[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)

It will look like this: -

Your badge will look like this:

+ +

It may also make sense to change your README.md or CONTRIBUTING.md to include or link to the Commitizen project so that your new contributors may learn more about installing and using Commitizen.

diff --git a/params.json b/params.json index a79fdce7..91c28d5c 100644 --- a/params.json +++ b/params.json @@ -1 +1 @@ -{"name":"Commitizen","tagline":"Simple commit conventions for internet citizens.","body":"### Commitizen for contributors\r\nWhen you commit with Commitizen, you'll be prompted to fill out any required commit fields at commit time. No more waiting until later for a git commit hook to run and reject your commit. No more digging through CONTRIBUTING.md to find what the preferred format is. Get instant feedback on your commit message formatting and be prompted for required fields.\r\n\r\n#### Installing the command line tool\r\nInstallation is as simple as running the following command (add sudo if on OSX/Linux):\r\n\r\n```\r\nnpm install -g commitizen\r\n```\r\n\r\n#### Using the command line tool\r\nNow, simply use `git cz` instead of `git commit` when committing. \r\n\r\nWhen you're working in a Commitizen friendly repository, you'll be prompted to fill in any required fields and your commit messages will be formatted according to the the standards defined by project maintainers. If you're not working in a Commitizen friendly repository, then `git cz` will work just the same as `git commit`.\r\n\r\n### Commitizen for project maintainers\r\nAs a project maintainer, making your repo Commitizen friendly allows you to select pre-existing commit message conventions or to create your own custom commit message convention. When a contributor to your repo uses Commitizen, they will be prompted for the correct fields at commit time. \r\n\r\n#### Making your repo Commitizen-friendly\r\n\r\nFor this example, we'll be setting up our repo to use [AngularJS's commit message convention](https://github.com/angular/angular.js/blob/master/CONTRIBUTING.md#-git-commit-guidelines) also known as [conventional-changelog](https://github.com/ajoslin/conventional-changelog).\r\n\r\nFirst, install the Commitizen conventional-changelog adapter into your project.\r\n\r\n```\r\nnpm install cz-conventional-changelog\r\n```\r\n\r\nThen just add **.cz.json** to the root of your repository with the following contents:\r\n\r\n```json\r\n{\r\n \"path\": \"node_modules/cz-conventional-changelog/\"\r\n}\r\n```\r\n\r\nThis just tells Commitizen which adapter we actually want our contributors to use when they try to commit to this repo.\r\n\r\n#### Congratulations your repo is Commitizen-friendly. Time to flaunt it!\r\n\r\nAdd the Commitizen-friendly badge to your README using the following markdown:\r\n```\r\n[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)\r\n```\r\n\r\nIt will look like this:\r\n[![Commitizen-friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)\r\n\r\nIt may also make sense to change your README.md or CONTRIBUTING.md to include or link to the Commitizen project so that your new contributors may learn more about installing and using Commitizen.\r\n\r\n### Philosophy\r\n\r\n#### About Commitizen\r\nCommitizen is an open source project that helps contributors be good open source citizens. It accomplishes this by prompting them to follow commit message conventions at commit time. It also empowers project maintainers to create or use predefined commit message conventions in their repos to better communicate their expectations to potential contributors.\r\n\r\n#### Commitizen or Commit Hooks\r\nBoth! Commitizen is not meant to be a replacement for git commit hooks. Rather, it is meant to work side-by-side with them to ensure a consistent and positive experience for your contributors. Commitizen treats the commit command as a declarative action. The contributor is declaring that they wish to contribute to your project. It is up to you as the maintainer to define what rules they should be following.\r\n\r\nWe accomplish this by letting you define which adapter you'd like to use in your project. Adapters just allow multiple projects to share the same commit message conventions. A good example of an adapter is the cz-conventional-commit adapter.\r\n\r\n### Authors and Contributors\r\nJim Cummins (@JimTheDev)","google":"","note":"Don't delete this file! It's used internally to help with page regeneration."} \ No newline at end of file +{"name":"Commitizen","tagline":"Simple commit conventions for internet citizens.","body":"### Commitizen for contributors\r\nWhen you commit with Commitizen, you'll be prompted to fill out any required commit fields at commit time. No more waiting until later for a git commit hook to run and reject your commit. No more digging through CONTRIBUTING.md to find what the preferred format is. Get instant feedback on your commit message formatting and be prompted for required fields.\r\n\r\n#### Installing the command line tool\r\nInstallation is as simple as running the following command (add sudo if on OSX/Linux):\r\n\r\n```\r\nnpm install -g commitizen\r\n```\r\n\r\n#### Using the command line tool\r\nNow, simply use `git cz` instead of `git commit` when committing. \r\n\r\nWhen you're working in a Commitizen friendly repository, you'll be prompted to fill in any required fields and your commit messages will be formatted according to the the standards defined by project maintainers. If you're not working in a Commitizen friendly repository, then `git cz` will work just the same as `git commit`.\r\n\r\n### Commitizen for project maintainers\r\nAs a project maintainer, making your repo Commitizen friendly allows you to select pre-existing commit message conventions or to create your own custom commit message convention. When a contributor to your repo uses Commitizen, they will be prompted for the correct fields at commit time. \r\n\r\n#### Making your repo Commitizen-friendly\r\n\r\nFor this example, we'll be setting up our repo to use [AngularJS's commit message convention](https://github.com/angular/angular.js/blob/master/CONTRIBUTING.md#-git-commit-guidelines) also known as [conventional-changelog](https://github.com/ajoslin/conventional-changelog).\r\n\r\nFirst, install the Commitizen conventional-changelog adapter into your project.\r\n\r\n```\r\nnpm install cz-conventional-changelog\r\n```\r\n\r\nThen just add **.cz.json** to the root of your repository with the following contents:\r\n\r\n```json\r\n{\r\n \"path\": \"node_modules/cz-conventional-changelog/\"\r\n}\r\n```\r\n\r\nThis just tells Commitizen which adapter we actually want our contributors to use when they try to commit to this repo.\r\n\r\n#### Congratulations your repo is Commitizen-friendly. Time to flaunt it!\r\n\r\nAdd the Commitizen-friendly badge to your README using the following markdown:\r\n```\r\n[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)\r\n```\r\n\r\nYour badge will look like this:\r\n\r\n[![Commitizen-friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)\r\n\r\nIt may also make sense to change your README.md or CONTRIBUTING.md to include or link to the Commitizen project so that your new contributors may learn more about installing and using Commitizen.\r\n\r\n### Philosophy\r\n\r\n#### About Commitizen\r\nCommitizen is an open source project that helps contributors be good open source citizens. It accomplishes this by prompting them to follow commit message conventions at commit time. It also empowers project maintainers to create or use predefined commit message conventions in their repos to better communicate their expectations to potential contributors.\r\n\r\n#### Commitizen or Commit Hooks\r\nBoth! Commitizen is not meant to be a replacement for git commit hooks. Rather, it is meant to work side-by-side with them to ensure a consistent and positive experience for your contributors. Commitizen treats the commit command as a declarative action. The contributor is declaring that they wish to contribute to your project. It is up to you as the maintainer to define what rules they should be following.\r\n\r\nWe accomplish this by letting you define which adapter you'd like to use in your project. Adapters just allow multiple projects to share the same commit message conventions. A good example of an adapter is the cz-conventional-commit adapter.\r\n\r\n### Authors and Contributors\r\nJim Cummins (@JimTheDev)","google":"","note":"Don't delete this file! It's used internally to help with page regeneration."} \ No newline at end of file From f61172fcc1ca4db995d1273674f141219c892600 Mon Sep 17 00:00:00 2001 From: Jim Cummins Date: Mon, 20 Apr 2015 14:02:46 -0500 Subject: [PATCH 10/12] use bradrhodes/GithubDocSync --- index.html | 97 +++++++++++------------------------------------------- 1 file changed, 20 insertions(+), 77 deletions(-) diff --git a/index.html b/index.html index 0287c1fd..5409bf4b 100644 --- a/index.html +++ b/index.html @@ -7,6 +7,24 @@ + + + + @@ -31,82 +49,7 @@

Simple commit conventions for internet citizens.

-Commitizen for contributors

- -

-Installing the command line tool

- -

Installation is as simple as running the following command (add sudo if on OSX/Linux):

- -

npm install -g commitizen
-

- -

-Using the command line tool

- -

Now, simply use git cz instead of git commit when committing.

- -

-Commitizen for project maintainers

- -

-Making your repo Commitizen-friendly

- -

For this example, we'll be setting up our repo to use AngularJS's commit message convention also known as conventional-changelog.

- -

First, install the Commitizen conventional-changelog adapter into your project.

- -

npm install cz-conventional-changelog
-

- -

Then just add .cz.json to the root of your repository with the following contents:

- -

{
-  "path": "node_modules/cz-conventional-changelog/"
-}

- -

This just tells Commitizen which adapter we actually want our contributors to use when they try to commit to this repo.

- -

-Congratulations your repo is Commitizen-friendly. Time to flaunt it!

- -

Add the Commitizen-friendly badge to your README using the following markdown:

- -

[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)
-

- -

Your badge will look like this:

- -

It may also make sense to change your README.md or CONTRIBUTING.md to include or link to the Commitizen project so that your new contributors may learn more about installing and using Commitizen.

- -

-Philosophy

- -

-About Commitizen

- -

-Commitizen or Commit Hooks

- -

-Authors and Contributors

- -

Jim Cummins (@JimTheDev)

@@ -118,4 +61,4 @@

- \ No newline at end of file + From ebf33ecf27e5aca9cbfdbcc2c52aa479ee3c34ad Mon Sep 17 00:00:00 2001 From: Jim Cummins Date: Mon, 20 Apr 2015 14:12:23 -0500 Subject: [PATCH 11/12] Add prereqs --- javascripts/base64.js | 142 +++++ javascripts/marked.js | 1266 +++++++++++++++++++++++++++++++++++++++++ 2 files changed, 1408 insertions(+) create mode 100644 javascripts/base64.js create mode 100644 javascripts/marked.js diff --git a/javascripts/base64.js b/javascripts/base64.js new file mode 100644 index 00000000..6e87eb7b --- /dev/null +++ b/javascripts/base64.js @@ -0,0 +1,142 @@ +/** +* +* Base64 encode / decode +* http://www.webtoolkit.info/ +* +**/ + +var Base64 = { + + // private property + _keyStr : "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/=", + + // public method for encoding + encode : function (input) { + var output = ""; + var chr1, chr2, chr3, enc1, enc2, enc3, enc4; + var i = 0; + + input = Base64._utf8_encode(input); + + while (i < input.length) { + + chr1 = input.charCodeAt(i++); + chr2 = input.charCodeAt(i++); + chr3 = input.charCodeAt(i++); + + enc1 = chr1 >> 2; + enc2 = ((chr1 & 3) << 4) | (chr2 >> 4); + enc3 = ((chr2 & 15) << 2) | (chr3 >> 6); + enc4 = chr3 & 63; + + if (isNaN(chr2)) { + enc3 = enc4 = 64; + } else if (isNaN(chr3)) { + enc4 = 64; + } + + output = output + + this._keyStr.charAt(enc1) + this._keyStr.charAt(enc2) + + this._keyStr.charAt(enc3) + this._keyStr.charAt(enc4); + + } + + return output; + }, + + // public method for decoding + decode : function (input) { + var output = ""; + var chr1, chr2, chr3; + var enc1, enc2, enc3, enc4; + var i = 0; + + input = input.replace(/[^A-Za-z0-9\+\/\=]/g, ""); + + while (i < input.length) { + + enc1 = this._keyStr.indexOf(input.charAt(i++)); + enc2 = this._keyStr.indexOf(input.charAt(i++)); + enc3 = this._keyStr.indexOf(input.charAt(i++)); + enc4 = this._keyStr.indexOf(input.charAt(i++)); + + chr1 = (enc1 << 2) | (enc2 >> 4); + chr2 = ((enc2 & 15) << 4) | (enc3 >> 2); + chr3 = ((enc3 & 3) << 6) | enc4; + + output = output + String.fromCharCode(chr1); + + if (enc3 != 64) { + output = output + String.fromCharCode(chr2); + } + if (enc4 != 64) { + output = output + String.fromCharCode(chr3); + } + + } + + output = Base64._utf8_decode(output); + + return output; + + }, + + // private method for UTF-8 encoding + _utf8_encode : function (string) { + string = string.replace(/\r\n/g,"\n"); + var utftext = ""; + + for (var n = 0; n < string.length; n++) { + + var c = string.charCodeAt(n); + + if (c < 128) { + utftext += String.fromCharCode(c); + } + else if((c > 127) && (c < 2048)) { + utftext += String.fromCharCode((c >> 6) | 192); + utftext += String.fromCharCode((c & 63) | 128); + } + else { + utftext += String.fromCharCode((c >> 12) | 224); + utftext += String.fromCharCode(((c >> 6) & 63) | 128); + utftext += String.fromCharCode((c & 63) | 128); + } + + } + + return utftext; + }, + + // private method for UTF-8 decoding + _utf8_decode : function (utftext) { + var string = ""; + var i = 0; + var c = c1 = c2 = 0; + + while ( i < utftext.length ) { + + c = utftext.charCodeAt(i); + + if (c < 128) { + string += String.fromCharCode(c); + i++; + } + else if((c > 191) && (c < 224)) { + c2 = utftext.charCodeAt(i+1); + string += String.fromCharCode(((c & 31) << 6) | (c2 & 63)); + i += 2; + } + else { + c2 = utftext.charCodeAt(i+1); + c3 = utftext.charCodeAt(i+2); + string += String.fromCharCode(((c & 15) << 12) | ((c2 & 63) << 6) | (c3 & 63)); + i += 3; + } + + } + + return string; + } + +} \ No newline at end of file diff --git a/javascripts/marked.js b/javascripts/marked.js new file mode 100644 index 00000000..717684c4 --- /dev/null +++ b/javascripts/marked.js @@ -0,0 +1,1266 @@ +/** + * marked - a markdown parser + * Copyright (c) 2011-2013, Christopher Jeffrey. (MIT Licensed) + * https://github.com/chjj/marked + */ + +;(function() { + +/** + * Block-Level Grammar + */ + +var block = { + newline: /^\n+/, + code: /^( {4}[^\n]+\n*)+/, + fences: noop, + hr: /^( *[-*_]){3,} *(?:\n+|$)/, + heading: /^ *(#{1,6}) *([^\n]+?) *#* *(?:\n+|$)/, + nptable: noop, + lheading: /^([^\n]+)\n *(=|-){2,} *(?:\n+|$)/, + blockquote: /^( *>[^\n]+(\n(?!def)[^\n]+)*\n*)+/, + list: /^( *)(bull) [\s\S]+?(?:hr|def|\n{2,}(?! )(?!\1bull )\n*|\s*$)/, + html: /^ *(?:comment|closed|closing) *(?:\n{2,}|\s*$)/, + def: /^ *\[([^\]]+)\]: *]+)>?(?: +["(]([^\n]+)[")])? *(?:\n+|$)/, + table: noop, + paragraph: /^((?:[^\n]+\n?(?!hr|heading|lheading|blockquote|tag|def))+)\n*/, + text: /^[^\n]+/ +}; + +block.bullet = /(?:[*+-]|\d+\.)/; +block.item = /^( *)(bull) [^\n]*(?:\n(?!\1bull )[^\n]*)*/; +block.item = replace(block.item, 'gm') + (/bull/g, block.bullet) + (); + +block.list = replace(block.list) + (/bull/g, block.bullet) + ('hr', '\\n+(?=\\1?(?:[-*_] *){3,}(?:\\n+|$))') + ('def', '\\n+(?=' + block.def.source + ')') + (); + +block.blockquote = replace(block.blockquote) + ('def', block.def) + (); + +block._tag = '(?!(?:' + + 'a|em|strong|small|s|cite|q|dfn|abbr|data|time|code' + + '|var|samp|kbd|sub|sup|i|b|u|mark|ruby|rt|rp|bdi|bdo' + + '|span|br|wbr|ins|del|img)\\b)\\w+(?!:/|[^\\w\\s@]*@)\\b'; + +block.html = replace(block.html) + ('comment', //) + ('closed', /<(tag)[\s\S]+?<\/\1>/) + ('closing', /])*?>/) + (/tag/g, block._tag) + (); + +block.paragraph = replace(block.paragraph) + ('hr', block.hr) + ('heading', block.heading) + ('lheading', block.lheading) + ('blockquote', block.blockquote) + ('tag', '<' + block._tag) + ('def', block.def) + (); + +/** + * Normal Block Grammar + */ + +block.normal = merge({}, block); + +/** + * GFM Block Grammar + */ + +block.gfm = merge({}, block.normal, { + fences: /^ *(`{3,}|~{3,}) *(\S+)? *\n([\s\S]+?)\s*\1 *(?:\n+|$)/, + paragraph: /^/ +}); + +block.gfm.paragraph = replace(block.paragraph) + ('(?!', '(?!' + + block.gfm.fences.source.replace('\\1', '\\2') + '|' + + block.list.source.replace('\\1', '\\3') + '|') + (); + +/** + * GFM + Tables Block Grammar + */ + +block.tables = merge({}, block.gfm, { + nptable: /^ *(\S.*\|.*)\n *([-:]+ *\|[-| :]*)\n((?:.*\|.*(?:\n|$))*)\n*/, + table: /^ *\|(.+)\n *\|( *[-:]+[-| :]*)\n((?: *\|.*(?:\n|$))*)\n*/ +}); + +/** + * Block Lexer + */ + +function Lexer(options) { + this.tokens = []; + this.tokens.links = {}; + this.options = options || marked.defaults; + this.rules = block.normal; + + if (this.options.gfm) { + if (this.options.tables) { + this.rules = block.tables; + } else { + this.rules = block.gfm; + } + } +} + +/** + * Expose Block Rules + */ + +Lexer.rules = block; + +/** + * Static Lex Method + */ + +Lexer.lex = function(src, options) { + var lexer = new Lexer(options); + return lexer.lex(src); +}; + +/** + * Preprocessing + */ + +Lexer.prototype.lex = function(src) { + src = src + .replace(/\r\n|\r/g, '\n') + .replace(/\t/g, ' ') + .replace(/\u00a0/g, ' ') + .replace(/\u2424/g, '\n'); + + return this.token(src, true); +}; + +/** + * Lexing + */ + +Lexer.prototype.token = function(src, top, bq) { + var src = src.replace(/^ +$/gm, '') + , next + , loose + , cap + , bull + , b + , item + , space + , i + , l; + + while (src) { + // newline + if (cap = this.rules.newline.exec(src)) { + src = src.substring(cap[0].length); + if (cap[0].length > 1) { + this.tokens.push({ + type: 'space' + }); + } + } + + // code + if (cap = this.rules.code.exec(src)) { + src = src.substring(cap[0].length); + cap = cap[0].replace(/^ {4}/gm, ''); + this.tokens.push({ + type: 'code', + text: !this.options.pedantic + ? cap.replace(/\n+$/, '') + : cap + }); + continue; + } + + // fences (gfm) + if (cap = this.rules.fences.exec(src)) { + src = src.substring(cap[0].length); + this.tokens.push({ + type: 'code', + lang: cap[2], + text: cap[3] + }); + continue; + } + + // heading + if (cap = this.rules.heading.exec(src)) { + src = src.substring(cap[0].length); + this.tokens.push({ + type: 'heading', + depth: cap[1].length, + text: cap[2] + }); + continue; + } + + // table no leading pipe (gfm) + if (top && (cap = this.rules.nptable.exec(src))) { + src = src.substring(cap[0].length); + + item = { + type: 'table', + header: cap[1].replace(/^ *| *\| *$/g, '').split(/ *\| */), + align: cap[2].replace(/^ *|\| *$/g, '').split(/ *\| */), + cells: cap[3].replace(/\n$/, '').split('\n') + }; + + for (i = 0; i < item.align.length; i++) { + if (/^ *-+: *$/.test(item.align[i])) { + item.align[i] = 'right'; + } else if (/^ *:-+: *$/.test(item.align[i])) { + item.align[i] = 'center'; + } else if (/^ *:-+ *$/.test(item.align[i])) { + item.align[i] = 'left'; + } else { + item.align[i] = null; + } + } + + for (i = 0; i < item.cells.length; i++) { + item.cells[i] = item.cells[i].split(/ *\| */); + } + + this.tokens.push(item); + + continue; + } + + // lheading + if (cap = this.rules.lheading.exec(src)) { + src = src.substring(cap[0].length); + this.tokens.push({ + type: 'heading', + depth: cap[2] === '=' ? 1 : 2, + text: cap[1] + }); + continue; + } + + // hr + if (cap = this.rules.hr.exec(src)) { + src = src.substring(cap[0].length); + this.tokens.push({ + type: 'hr' + }); + continue; + } + + // blockquote + if (cap = this.rules.blockquote.exec(src)) { + src = src.substring(cap[0].length); + + this.tokens.push({ + type: 'blockquote_start' + }); + + cap = cap[0].replace(/^ *> ?/gm, ''); + + // Pass `top` to keep the current + // "toplevel" state. This is exactly + // how markdown.pl works. + this.token(cap, top, true); + + this.tokens.push({ + type: 'blockquote_end' + }); + + continue; + } + + // list + if (cap = this.rules.list.exec(src)) { + src = src.substring(cap[0].length); + bull = cap[2]; + + this.tokens.push({ + type: 'list_start', + ordered: bull.length > 1 + }); + + // Get each top-level item. + cap = cap[0].match(this.rules.item); + + next = false; + l = cap.length; + i = 0; + + for (; i < l; i++) { + item = cap[i]; + + // Remove the list item's bullet + // so it is seen as the next token. + space = item.length; + item = item.replace(/^ *([*+-]|\d+\.) +/, ''); + + // Outdent whatever the + // list item contains. Hacky. + if (~item.indexOf('\n ')) { + space -= item.length; + item = !this.options.pedantic + ? item.replace(new RegExp('^ {1,' + space + '}', 'gm'), '') + : item.replace(/^ {1,4}/gm, ''); + } + + // Determine whether the next list item belongs here. + // Backpedal if it does not belong in this list. + if (this.options.smartLists && i !== l - 1) { + b = block.bullet.exec(cap[i + 1])[0]; + if (bull !== b && !(bull.length > 1 && b.length > 1)) { + src = cap.slice(i + 1).join('\n') + src; + i = l - 1; + } + } + + // Determine whether item is loose or not. + // Use: /(^|\n)(?! )[^\n]+\n\n(?!\s*$)/ + // for discount behavior. + loose = next || /\n\n(?!\s*$)/.test(item); + if (i !== l - 1) { + next = item.charAt(item.length - 1) === '\n'; + if (!loose) loose = next; + } + + this.tokens.push({ + type: loose + ? 'loose_item_start' + : 'list_item_start' + }); + + // Recurse. + this.token(item, false, bq); + + this.tokens.push({ + type: 'list_item_end' + }); + } + + this.tokens.push({ + type: 'list_end' + }); + + continue; + } + + // html + if (cap = this.rules.html.exec(src)) { + src = src.substring(cap[0].length); + this.tokens.push({ + type: this.options.sanitize + ? 'paragraph' + : 'html', + pre: cap[1] === 'pre' || cap[1] === 'script' || cap[1] === 'style', + text: cap[0] + }); + continue; + } + + // def + if ((!bq && top) && (cap = this.rules.def.exec(src))) { + src = src.substring(cap[0].length); + this.tokens.links[cap[1].toLowerCase()] = { + href: cap[2], + title: cap[3] + }; + continue; + } + + // table (gfm) + if (top && (cap = this.rules.table.exec(src))) { + src = src.substring(cap[0].length); + + item = { + type: 'table', + header: cap[1].replace(/^ *| *\| *$/g, '').split(/ *\| */), + align: cap[2].replace(/^ *|\| *$/g, '').split(/ *\| */), + cells: cap[3].replace(/(?: *\| *)?\n$/, '').split('\n') + }; + + for (i = 0; i < item.align.length; i++) { + if (/^ *-+: *$/.test(item.align[i])) { + item.align[i] = 'right'; + } else if (/^ *:-+: *$/.test(item.align[i])) { + item.align[i] = 'center'; + } else if (/^ *:-+ *$/.test(item.align[i])) { + item.align[i] = 'left'; + } else { + item.align[i] = null; + } + } + + for (i = 0; i < item.cells.length; i++) { + item.cells[i] = item.cells[i] + .replace(/^ *\| *| *\| *$/g, '') + .split(/ *\| */); + } + + this.tokens.push(item); + + continue; + } + + // top-level paragraph + if (top && (cap = this.rules.paragraph.exec(src))) { + src = src.substring(cap[0].length); + this.tokens.push({ + type: 'paragraph', + text: cap[1].charAt(cap[1].length - 1) === '\n' + ? cap[1].slice(0, -1) + : cap[1] + }); + continue; + } + + // text + if (cap = this.rules.text.exec(src)) { + // Top-level should never reach here. + src = src.substring(cap[0].length); + this.tokens.push({ + type: 'text', + text: cap[0] + }); + continue; + } + + if (src) { + throw new + Error('Infinite loop on byte: ' + src.charCodeAt(0)); + } + } + + return this.tokens; +}; + +/** + * Inline-Level Grammar + */ + +var inline = { + escape: /^\$[\\`*{}\[\]()#+\-.!_>])/, + autolink: /^<([^ >]+(@|:\/)[^ >]+)>/, + url: noop, + tag: /^|^<\/?\w+(?:"[^"]*"|'[^']*'|[^'">])*?>/, + link: /^!?\[(inside)\]\(href$/, + reflink: /^!?\[(inside)\]\s*\[([^\]]*)\]/, + nolink: /^!?\[((?:\[[^\]]*\]|[^\[\]])*)\]/, + strong: /^__([\s\S]+?)__(?!_)|^\*\*([\s\S]+?)\*\*(?!\*)/, + em: /^\b_((?:__|[\s\S])+?)_\b|^\*((?:\*\*|[\s\S])+?)\*(?!\*)/, + code: /^(`+)\s*([\s\S]*?[^`])\s*\1(?!`)/, + br: /^ {2,}\n(?!\s*$)/, + del: noop, + text: /^[\s\S]+?(?=[\\?(?:\s+['"]([\s\S]*?)['"])?\s*/; + +inline.link = replace(inline.link) + ('inside', inline._inside) + ('href', inline._href) + (); + +inline.reflink = replace(inline.reflink) + ('inside', inline._inside) + (); + +/** + * Normal Inline Grammar + */ + +inline.normal = merge({}, inline); + +/** + * Pedantic Inline Grammar + */ + +inline.pedantic = merge({}, inline.normal, { + strong: /^__(?=\S)([\s\S]*?\S)__(?!_)|^\*\*(?=\S)([\s\S]*?\S)\*\*(?!\*)/, + em: /^_(?=\S)([\s\S]*?\S)_(?!_)|^\*(?=\S)([\s\S]*?\S)\*(?!\*)/ +}); + +/** + * GFM Inline Grammar + */ + +inline.gfm = merge({}, inline.normal, { + escape: replace(inline.escape)('])', '~|])')(), + url: /^(https?:\/\/[^\s<]+[^<.,:;"')\]\s])/, + del: /^~~(?=\S)([\s\S]*?\S)~~/, + text: replace(inline.text) + (']|', '~]|') + ('|', '|https?://|') + () +}); + +/** + * GFM + Line Breaks Inline Grammar + */ + +inline.breaks = merge({}, inline.gfm, { + br: replace(inline.br)('{2,}', '*')(), + text: replace(inline.gfm.text)('{2,}', '*')() +}); + +/** + * Inline Lexer & Compiler + */ + +function InlineLexer(links, options) { + this.options = options || marked.defaults; + this.links = links; + this.rules = inline.normal; + this.renderer = this.options.renderer || new Renderer; + this.renderer.options = this.options; + + if (!this.links) { + throw new + Error('Tokens array requires a `links` property.'); + } + + if (this.options.gfm) { + if (this.options.breaks) { + this.rules = inline.breaks; + } else { + this.rules = inline.gfm; + } + } else if (this.options.pedantic) { + this.rules = inline.pedantic; + } +} + +/** + * Expose Inline Rules + */ + +InlineLexer.rules = inline; + +/** + * Static Lexing/Compiling Method + */ + +InlineLexer.output = function(src, links, options) { + var inline = new InlineLexer(links, options); + return inline.output(src); +}; + +/** + * Lexing/Compiling + */ + +InlineLexer.prototype.output = function(src) { + var out = '' + , link + , text + , href + , cap; + + while (src) { + // escape + if (cap = this.rules.escape.exec(src)) { + src = src.substring(cap[0].length); + out += cap[1]; + continue; + } + + // autolink + if (cap = this.rules.autolink.exec(src)) { + src = src.substring(cap[0].length); + if (cap[2] === '@') { + text = cap[1].charAt(6) === ':' + ? this.mangle(cap[1].substring(7)) + : this.mangle(cap[1]); + href = this.mangle('mailto:') + text; + } else { + text = escape(cap[1]); + href = text; + } + out += this.renderer.link(href, null, text); + continue; + } + + // url (gfm) + if (!this.inLink && (cap = this.rules.url.exec(src))) { + src = src.substring(cap[0].length); + text = escape(cap[1]); + href = text; + out += this.renderer.link(href, null, text); + continue; + } + + // tag + if (cap = this.rules.tag.exec(src)) { + if (!this.inLink && /^/i.test(cap[0])) { + this.inLink = false; + } + src = src.substring(cap[0].length); + out += this.options.sanitize + ? escape(cap[0]) + : cap[0]; + continue; + } + + // link + if (cap = this.rules.link.exec(src)) { + src = src.substring(cap[0].length); + this.inLink = true; + out += this.outputLink(cap, { + href: cap[2], + title: cap[3] + }); + this.inLink = false; + continue; + } + + // reflink, nolink + if ((cap = this.rules.reflink.exec(src)) + || (cap = this.rules.nolink.exec(src))) { + src = src.substring(cap[0].length); + link = (cap[2] || cap[1]).replace(/\s+/g, ' '); + link = this.links[link.toLowerCase()]; + if (!link || !link.href) { + out += cap[0].charAt(0); + src = cap[0].substring(1) + src; + continue; + } + this.inLink = true; + out += this.outputLink(cap, link); + this.inLink = false; + continue; + } + + // strong + if (cap = this.rules.strong.exec(src)) { + src = src.substring(cap[0].length); + out += this.renderer.strong(this.output(cap[2] || cap[1])); + continue; + } + + // em + if (cap = this.rules.em.exec(src)) { + src = src.substring(cap[0].length); + out += this.renderer.em(this.output(cap[2] || cap[1])); + continue; + } + + // code + if (cap = this.rules.code.exec(src)) { + src = src.substring(cap[0].length); + out += this.renderer.codespan(escape(cap[2], true)); + continue; + } + + // br + if (cap = this.rules.br.exec(src)) { + src = src.substring(cap[0].length); + out += this.renderer.br(); + continue; + } + + // del (gfm) + if (cap = this.rules.del.exec(src)) { + src = src.substring(cap[0].length); + out += this.renderer.del(this.output(cap[1])); + continue; + } + + // text + if (cap = this.rules.text.exec(src)) { + src = src.substring(cap[0].length); + out += escape(this.smartypants(cap[0])); + continue; + } + + if (src) { + throw new + Error('Infinite loop on byte: ' + src.charCodeAt(0)); + } + } + + return out; +}; + +/** + * Compile Link + */ + +InlineLexer.prototype.outputLink = function(cap, link) { + var href = escape(link.href) + , title = link.title ? escape(link.title) : null; + + return cap[0].charAt(0) !== '!' + ? this.renderer.link(href, title, this.output(cap[1])) + : this.renderer.image(href, title, escape(cap[1])); +}; + +/** + * Smartypants Transformations + */ + +InlineLexer.prototype.smartypants = function(text) { + if (!this.options.smartypants) return text; + return text + // em-dashes + .replace(/--/g, '\u2014') + // opening singles + .replace(/(^|[-\u2014/(\[{"\s])'/g, '$1\u2018') + // closing singles & apostrophes + .replace(/'/g, '\u2019') + // opening doubles + .replace(/(^|[-\u2014/(\[{\u2018\s])"/g, '$1\u201c') + // closing doubles + .replace(/"/g, '\u201d') + // ellipses + .replace(/\.{3}/g, '\u2026'); +}; + +/** + * Mangle Links + */ + +InlineLexer.prototype.mangle = function(text) { + var out = '' + , l = text.length + , i = 0 + , ch; + + for (; i < l; i++) { + ch = text.charCodeAt(i); + if (Math.random() > 0.5) { + ch = 'x' + ch.toString(16); + } + out += '&#' + ch + ';'; + } + + return out; +}; + +/** + * Renderer + */ + +function Renderer(options) { + this.options = options || {}; +} + +Renderer.prototype.code = function(code, lang, escaped) { + if (this.options.highlight) { + var out = this.options.highlight(code, lang); + if (out != null && out !== code) { + escaped = true; + code = out; + } + } + + if (!lang) { + return '

'
+      + (escaped ? code : escape(code, true))
+      + '\n

'; + } + + return '

'
+    + (escaped ? code : escape(code, true))
+    + '\n

\n'; +}; + +Renderer.prototype.blockquote = function(quote) { + return '

\n' + quote + '

\n'; +}; + +Renderer.prototype.html = function(html) { + return html; +}; + +Renderer.prototype.heading = function(text, level, raw) { + return '' + + text + + '\n'; +}; + +Renderer.prototype.hr = function() { + return this.options.xhtml ? '

\n' : '

\n'; +}; + +Renderer.prototype.list = function(body, ordered) { + var type = ordered ? 'ol' : 'ul'; + return '<' + type + '>\n' + body + '\n'; +}; + +Renderer.prototype.listitem = function(text) { + return '

' + text + '

\n'; +}; + +Renderer.prototype.paragraph = function(text) { + return '

' + text + '

\n'; +}; + +Renderer.prototype.table = function(header, body) { + return '\n' + + '\n' + + header + + '\n' + + '\n' + + body + + '\n' + + '

An error occured:

'
+        + escape(e.message + '', true)
+        + '

'; + } + throw e; + } +} + +/** + * Options + */ + +marked.options = +marked.setOptions = function(opt) { + merge(marked.defaults, opt); + return marked; +}; + +marked.defaults = { + gfm: true, + tables: true, + breaks: false, + pedantic: false, + sanitize: false, + smartLists: false, + silent: false, + highlight: null, + langPrefix: 'lang-', + smartypants: false, + headerPrefix: '', + renderer: new Renderer, + xhtml: false +}; + +/** + * Expose + */ + +marked.Parser = Parser; +marked.parser = Parser.parse; + +marked.Renderer = Renderer; + +marked.Lexer = Lexer; +marked.lexer = Lexer.lex; + +marked.InlineLexer = InlineLexer; +marked.inlineLexer = InlineLexer.output; + +marked.parse = marked; + +if (typeof exports === 'object') { + module.exports = marked; +} else if (typeof define === 'function' && define.amd) { + define(function() { return marked; }); +} else { + this.marked = marked; +} + +}).call(function() { + return this || (typeof window !== 'undefined' ? window : global); +}()); \ No newline at end of file From 922e5dbe448da156f71d73a02ca64fe6209e7c6b Mon Sep 17 00:00:00 2001 From: Josh Holland Date: Tue, 18 Sep 2018 18:23:07 +0100 Subject: [PATCH 12/12] docs: fix font in code blocks (#568) Before: ![image](https://user-images.githubusercontent.com/9433472/45703506-6af36c00-bb6c-11e8-90a1-4c2f12aed705.png) After: ![image](https://user-images.githubusercontent.com/9433472/45703509-721a7a00-bb6c-11e8-8f94-f4c182f35aac.png) Fixes #565. --- stylesheets/stylesheet.css | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/stylesheets/stylesheet.css b/stylesheets/stylesheet.css index d58131ab..809b433d 100644 --- a/stylesheets/stylesheet.css +++ b/stylesheets/stylesheet.css @@ -167,7 +167,7 @@ a.button span { code, pre { margin-bottom: 30px; - font-family: Monaco, "Bitstream Vera Sans Mono", "Lucida Console", Terminal; + font-family: Monaco, "Bitstream Vera Sans Mono", "Lucida Console", Terminal, monospace; font-size: 14px; color: #222; }

+What is Commitizen?

+For contributors

+Installation

+Usage

+For maintainers

+Philosophy

+Authors and Contributors

Simple commit conventions for internet citizens.

-What is Commitizen?

+About Commitizen

Simple commit conventions for internet citizens.

-Commitizen

-About Commitizen

-For contributors

+Commitizen for contributors

-Installation

+Installation

-Usage

+Usage

-For maintainers

+Commitizen for maintainers

This just tells Commitizen which adapter we actually want our contributors to use when for this repo. Congrats! You've made it much easier for your contributors to be good net citizens! -

-Philosophy

+Philosophy

Simple commit conventions for internet citizens.

-About Commitizen

Commitizen for contributors

Philosophy

+About Commitizen

+Commitizen or Commit Hooks

-Installation

-Usage

-Commitizen for maintainers

+Making your repo Commitizen-friendly

This just tells Commitizen which adapter we actually want our contributors to use when for this repo. Congrats! You've made it much easier for your contributors to be good net citizens! +

+You're Commitizen-friendly. Time to flaunt it!

Philosophy

This just tells Commitizen which adapter we actually want our contributors to use when for this repo. Congrats! You've made it much easier for your contributors to be good net citizens!

-You're Commitizen-friendly. Time to flaunt it!

It may also make sense to change your README.md or CONTRIBUTING.md to include or link to the Commitizen project so that your new contributors may learn more about installing and using Commitizen. -

-Philosophy

+Philosophy

-About Commitizen

+About Commitizen

-Commitizen or Commit Hooks

+Commitizen or Commit Hooks

Congratulations your repo is Commitizen-friendly. Time to flaunt it!

Simple commit conventions for internet citizens.

-Commitizen for contributors

-Installing the command line tool

-Using the command line tool

-Commitizen for project maintainers

-Making your repo Commitizen-friendly

-Congratulations your repo is Commitizen-friendly. Time to flaunt it!

-Philosophy

-About Commitizen

-Commitizen or Commit Hooks

-Authors and Contributors

This just tells Commitizen which adapter we actually want our contributors to use when for this repo. Congrats! You've made it much easier for your contributors to be good net citizens!
-

This just tells Commitizen which adapter we actually want our contributors to use when for this repo. Congrats! You've made it much easier for your contributors to be good net citizens!
+

It may also make sense to change your README.md or CONTRIBUTING.md to include or link to the Commitizen project so that your new contributors may learn more about installing and using Commitizen.
-