revel-commit - npm Package Compare versions

Comparing version 1.1.2 to 1.2.0

package.json

 {
   "name": "revel-commit",
-  "version": "1.1.2",
+  "version": "1.2.0",
   "description": "Commitizen wrapper following the conventional-changelog format and asking for Shortcut story at Revel.",
@@ -16,2 +16,5 @@ "bin": "./revel-cli.js",
   "homepage": "https://github.com/hellorevel/revel-commit",
+  "scripts": {
+    "c": "yarn revel-commit"
+  },
   "dependencies": {
@@ -27,4 +30,4 @@ "@dionlarson/commitizen": "^0.0.0-semantically-released",
   "devDependencies": {
-    "revel-commit": "^1.0.11"
+    "revel-commit": "^1.1.2"
   }
 }

README.md

 # revel-commit
 
-Installation instructions can be found [here](https://gist.github.com/dionlarson/4c369b9a2f9f7bf00eae14751719ccd8/)!
+[![npm version](https://img.shields.io/npm/v/revel-commit.svg?style=flat-square)](https://www.npmjs.org/package/cz-conventional-changelog-for-shortcut)
+[![npm downloads](https://img.shields.io/npm/dm/revel-commit.svg?style=flat-square)](http://npm-stat.com/charts.html?package=cz-conventional-changelog-for-shortcut&from=2015-08-01)
+
+![Gif of revel-commit being used in the terminal](https://gist.githubusercontent.com/dionlarson/4c369b9a2f9f7bf00eae14751719ccd8/raw/86ec20f9f6dab0489a9e57da9ba28d20dc904c6a/revel-commit.gif)
+
+[Revel](https://www.hellorevel.com/about) Engineering's custom wrapper around [cz-conventional-changelog-for-shortcut](https://github.com/dionlarson/cz-conventional-changelog-for-shortcut), a part of the [commitizen](https://github.com/commitizen/cz-cli) family. Prompts for [conventional changelog](https://github.com/conventional-changelog/conventional-changelog) standard and also prompts for a mandatory Shortcut story.
+
+## Features
+
+- Works seamlessly with semantic-release 🚀
+- Works seamlessly with Shortcut smart commits
+- Automatically detects the Shortcut story from the branch name
+
+## Quickstart
+
+### Installation
+
+```bash
+yarn add -D revel-commit
+```
+
+### Usage
+
+```
+yarn revel-commit
+```
+
+Most Revel repos will have a shorthand setup under `yarn c`, you may prefer to set up a git alias for `git cz`.

types.js

@@ -7,3 +7,3 @@ // Some space characters manually added to descriptions to adjust spacing.
   "✨ feat": {
-    description: "A new feature that is long",
+    description: "A new feature",
     title: "Features",
@@ -72,2 +72,6 @@ },
   },
+  "📱 feat": {
+    description: "A new feature specific to the native mobile apps",
+    title: "Mobile Features",
+  },
 };

Fixed alerts

No tests

Quality

Package does not have any tests. This is a strong signal of a poorly maintained or low quality package.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

5049

increased by37.73%

Lines of code

100

increased by4.17%

Number of low quality alerts

0

decreased by-100%

Number of lines in readme file

31

increased by675%

No dependency changes