+ docs

jkour · Jan 9, 2020 · ed3fc93 · ed3fc93
1 parent f7c4ce6
commit ed3fc93
Show file tree

Hide file tree

Showing 2 changed files with 28 additions and 0 deletions.
diff --git a/ChangeLog.md b/ChangeLog.md
@@ -0,0 +1,11 @@
+# Pimlico
+This document describes the changes in Pimlico
+
+## [1.0.0] - 2020 - 01 - 09
+### Added
+- First public release
+
+
+***********************
+![keep-a-change-log-image](https://camo.githubusercontent.com/2cf6cef5c34bffa21f0175c989c06284714bfd46/68747470733a2f2f64337676366c703535716a6171632e636c6f756466726f6e742e6e65742f6974656d732f314c31773076343331563064314b3431306633592f6b656570414368616e67656c6f672d6c6f676f2d6461726b2e737667) 
+This change log supports the [keep-a-changelog](https://keepachangelog.com) initiative
diff --git a/GitCommitWritingStyle.txt b/GitCommitWritingStyle.txt
@@ -0,0 +1,17 @@
+Git Commit Writing Guide
+Git commit messages follow the general guidelines widely available (atomic commits, imperative writing style, etc.)
+
+In addition, commits can use the following semantics:
+
+Commit		Element	Equivalent							Commit Message Example
++			Add										+ methods to calculate ratios
+-			Remove										- redundant calls to API
+*			Update										* project files
+Dolphins	Used to describe that the commit has 
+			some necessary changes but nothing 
+			relevant (eg. a blank line was added, 
+			the newly saved file has rearranged 
+			elements in the settings file, etc.)
+
+			Use this when the modified files in the 
+			commit have just "indescribable" changes