From ed3fc93095ca11b9cde96863c64ffda754611244 Mon Sep 17 00:00:00 2001 From: John Kouraklis Date: Thu, 9 Jan 2020 23:44:29 +0000 Subject: [PATCH] + docs --- ChangeLog.md | 11 +++++++++++ GitCommitWritingStyle.txt | 17 +++++++++++++++++ 2 files changed, 28 insertions(+) create mode 100644 ChangeLog.md create mode 100644 GitCommitWritingStyle.txt diff --git a/ChangeLog.md b/ChangeLog.md new file mode 100644 index 0000000..1a08b78 --- /dev/null +++ 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 \ No newline at end of file diff --git a/GitCommitWritingStyle.txt b/GitCommitWritingStyle.txt new file mode 100644 index 0000000..dce1f3f --- /dev/null +++ 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