feat: info command for angular

woile · woile · commit 3a8a45100a78 · 2017-10-08T11:54:35.000+02:00
diff --git a/README.rst b/README.rst
@@ -83,7 +83,7 @@ Help
 Configuration
 ==============
 
-You can create in your project folder a filled called :code:`.cz`, :code:`.cz.cfg` or in your :code:`setup.cfg`
+You can create in your project folder a file called :code:`.cz`, :code:`.cz.cfg` or in your :code:`setup.cfg`
 or if you want to configure the global default in your user's home folder a :code:`.cz` file
 with the following information:
 
diff --git a/commitizen/cz/cz_angular.py b/commitizen/cz/cz_angular.py
@@ -1,3 +1,4 @@
+import os
 from commitizen.cz.cz_base import BaseCommitizen
 
 
@@ -116,3 +117,10 @@ def schema(self):
                 '<body>\n'
                 '<BLANK LINE>\n'
                 '<footer>')
+
+    def info(self):
+        dir_path = os.path.dirname(os.path.realpath(__file__))
+        filepath = os.path.join(dir_path, 'cz_angular_info.txt')
+        with open(filepath, 'r') as f:
+            content = f.read()
+        return content
diff --git a/commitizen/cz/cz_angular_info.txt b/commitizen/cz/cz_angular_info.txt
@@ -0,0 +1,20 @@
+Commit Message Format
+
+Each commit message consists of a header, a body and a footer. The header has a special format that
+includes a type, a scope and a subject:
+
+<type>(<scope>): <subject>
+<BLANK LINE>
+<body>
+<BLANK LINE>
+<footer>
+
+The header is mandatory and the scope of the header is optional.
+
+Any line of the commit message cannot be longer 100 characters! This allows the message to be easier
+to read on GitHub as well as in various git tools.
+
+Footer should contain a closing reference to an issue if any.
+
+This leads to more readable messages that are easy to follow when looking through the project history.
+But also, the git commit messages can be used to generate the changelog.
