{%= name %} [![npm version][npmv-img]][npmv-url] [![github release][github-release-img]][github-release-url] [![License][license-img]][license-url]
{%= description %}
{% if (verb.related && verb.related.highlight) { %} You might also be interested in [{%= verb.related.highlight %}][highlighted-link] or in the other related projects. {% } %}
[![bitHound Code][bithound-code-img]][bithound-code-url]
If you have any how-to kind of questions, please read Code of Conduct and ping me on twitter or [open an issue][open-issue-url].
You may also read the Contributing Guide. There, beside "How to contribute?", we describe everything stated by the badges.
Project is semantically & automatically released on [CircleCI][codecov-url] with [new-release][] and its New Release Github Bot.
![All Contributors Spec][all-contributors-img]
This project requires Node.js v{%= engines.node.slice(2) %} or above. Install it using yarn v{%= engines.yarn.slice(2) %}+ or npm v{%= engines.npm.slice(2) %}+ package managers.
$ yarn add {%= name %}
Or install it globally and for example run gitcommit --scope. It will prompt you with questions
for commit type, commit scope and commit subject (short description). The type and subject questions are required always, so you can't skip them.
$ yarn global add {%= name %}
All git commit flags are available too.
# -s is --signoff, -S is --gpg-sign
$ gitcommit -S -s --scope --body --footer
# equivalent of above is following
# where -x is --scope, -y is --body and -w is --footer
$ gitcommit -Ssxyw
Above command will GPG Sign commit, add Sign-off-by at the end line, prompt
for commit scope, body and footer. Consider we commit breaking change.
$ gitcommit -Ssxyw
? Select the type of this change ›
❯ fix: A bug fix
feat: New feature
major: Breaking change
chore: Non src or test files changes
docs: Documentation only changes
✔ What is the scope of this change? … refactor
✔ Short, imperative tense description … huge api change
✔ Longer description (or fixes #17423, closes #33) … some pretty long body description.
✔ List issues or PRs (e.g. fixes #1771, resolves #371) … fixes #33, resolves #511
The actual git commit command which will be executed is like
$ git commit --allow-empty-message -S -s -m "major(refactor): huge api change" -m "" -m "some pretty long body description." -m "" -m "fixes #33, closes #511"
Review carefully the provided examples and the working tests.
{%= apidocs('src/index.js') %}
{% if (verb.related && verb.related.list && verb.related.list.length) { %}
Some of these projects are used here or were inspiration for this one, others are just related. So, thanks for your existance! {%= related(verb.related.list, { words: 12 }) %} {% } %}
Please read the Contributing Guide and Code of Conduct documents for advices.
For bugs reports and feature requests, [please create an issue][open-issue-url].
Thanks to the hard work of these wonderful people this project is alive and it also follows the all-contributors specification.
Pull requests, stars and all kind of contributions are always welcome.
You can see who uses {%= name %} in the USERS.md file. Please feel free adding this file if it not exists.
If you or your organization are using this project, consider adding yourself to the list of users. Thank You!
Copyright (c) {%= licenseStart %}-present, [Charlike Mike Reagent][author-link] <[email protected]>.
Released under the [{%= license %} License][license-url].
{%= include('footer') %}
Project automation and management with [hela][] task framework.
{%= reflinks(verb.reflinks) %}
[npmv-url]: https://www.npmjs.com/package/{%= name %} [npmv-img]: https://img.shields.io/npm/v/{%= name %}.svg?label=npm%20version
[github-release-url]: https://github.com/{%= repository %}/releases/latest [github-release-img]: https://img.shields.io/github/release/{%= repository %}.svg?label=github%20release
[license-url]: https://github.com/{%= repository %}/blob/master/LICENSE [license-img]: https://img.shields.io/badge/license-{%= license.replace('-', '%20') %}-blue.svg
[bithound-score-url]: https://www.bithound.io/github/{%= repository %} [bithound-score-img]: https://www.bithound.io/github/{%= repository %}/badges/score.svg
[bithound-code-url]: https://www.bithound.io/github/{%= repository %} [bithound-code-img]: https://www.bithound.io/github/{%= repository %}/badges/code.svg
[circleci-url]: https://circleci.com/gh/{%= repository %}/tree/master [circleci-img]: https://img.shields.io/circleci/project/github/{%= repository %}/master.svg
[codecov-url]: https://codecov.io/gh/{%= repository %} [codecov-img]: https://img.shields.io/codecov/c/github/{%= repository %}/master.svg
[bithound-deps-url]: https://www.bithound.io/github/{%= repository %}/dependencies/npm [bithound-deps-img]: https://www.bithound.io/github/{%= repository %}/badges/dependencies.svg
[dependencies-url]: https://david-dm.org/{%= repository %} [dependencies-img]: https://img.shields.io/david/{%= repository %}.svg
[nodesecurity-url]: https://nodesecurity.io/orgs/tunnckocore/projects/{%= nspId %}/master [nodesecurity-img]: https://nodesecurity.io/orgs/tunnckocore/projects/{%= nspId %}/badge
[nodeversion-img]: https://img.shields.io/node/v/{%= name %}.svg
[all-contributors-img]: https://img.shields.io/github/contributors/{%= repository %}.svg?label=all%20contributors&colorB=ffa500
[downloads-weekly-img]: https://img.shields.io/npm/dw/{%= name %}.svg [downloads-monthly-img]: https://img.shields.io/npm/dm/{%= name %}.svg [downloads-total-img]: https://img.shields.io/npm/dt/{%= name %}.svg
[share-love-url]: https://twitter.com/intent/tweet?text={%= encodeURI(homepage) %}&via=tunnckoCore [share-love-img]: https://img.shields.io/badge/tweet-about-1da1f2.svg
[open-issue-url]: https://github.com/{%= repository %}/issues/new [highlighted-link]: https://ghub.now.sh/{%= verb.related.highlight %} [author-link]: http://tunnckocore.com