Add project info documents

creof · Oct 20, 2015 · f039286 · f039286
1 parent 2fee3eb
commit f039286
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,9 @@
+# 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]
+### Added
+- Change log file to chronicle changes.
+- Stub TODO.md file.
+- CONTRIBUTING.md file with guidelines.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,7 @@
+(this is a work in progress)
+
+- Code formatting MUST 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/TODO.md b/TODO.md