Added a number of documentation files.

creof · Oct 19, 2015 · 74f3091 · 74f3091
1 parent 917aa15
commit 74f3091
Show file tree

Hide file tree

Showing 4 changed files with 23 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,12 @@
+# Change Log
+All notable changes to this project will be documented in this file using the [Keep a CHANGELOG](http://keepachangelog.com/) principles.
+This project adheres to [Semantic Versioning](http://semver.org/).
+
+## [Unreleased][unreleased]
+
+## [0.1] - 2015-10-29
+### Added
+- Change log file to chronicle changes.
+- TODO.md file.
+- CONTRIBUTING.md file with guidelines.
+- README.md file.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,7 @@
+(this is a work in progress)
+
+- Code formatting should follow PSR-2.
+- Issues should include code and/or data to reproduce the issue.
+- PR's for issues should include test(s) for issue.
+- PR's should have adequate documentation (commit messages, comments, etc.) to readily convey what and/or why.  
+- Code should attempt to follow [Object Calisthenics](http://www.xpteam.com/jeff/writings/objectcalisthenics.rtf) methodology.
diff --git a/README.md b/README.md
@@ -0,0 +1,3 @@
+# creof/geo-parser
+
+Doctrine2 pre-insert UUID id generator using PECL UUID (*nix) or COM (Windows)
diff --git a/TODO.md b/TODO.md
@@ -0,0 +1 @@
+- Usage documentation.
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# creof/geo-parser

		Doctrine2 pre-insert UUID id generator using PECL UUID (*nix) or COM (Windows)