CJKay/template

The repository templates I use for my GitHub projects.

★ 0Forks 0JavaScriptGitHub ↗Compare
template

README

Repository template

GitHub package.json version GitHub license

This template demonstrates a simple, language-agnostic repository layout. It includes a package.json file describing the basic metadata of the repository, a license file, a bare-bones changelog, and configurations for commitlint and Commitizen. standard-version is included with the tools installed by npm install, and it has been used to generate the changelog boilerplate.

License

This repository is licensed under the BSD Zero Clause license. As such, you are free to re-license repositories derived from this template as you wish.

Usage

This template includes several Node.js tools, pulled in via development dependencies. To install these tools, use:

npm install

This will install the following tools within the node_modules directory:

It will also install a prepare-commit-msg hook invoking Commitizen and a commit-msg hook invoking commitlint, such that these tools are automatically integrated into your normal Git workflow. These hooks are not installed globally and will not apply outside of your newly-created repository.

Contributors

CJKay

Issues