Add CHANGELOG to go along with release scripts

ponylang · Aug 4, 2019 · cd099c5 · cd099c5
1 parent c7ba13b
commit cd099c5
Show file tree

Hide file tree

Showing 3 changed files with 26 additions and 0 deletions.
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -1,6 +1,13 @@
 version: 2
 
 jobs:
+  verify-changelog:
+    docker:
+      - image: ponylang/changelog-tool:release
+    steps:
+      - checkout
+      - run: changelog-tool verify
+
   release-vs-ponyc-release:
     docker:
       - image: ponylang/ponyc:release
@@ -33,6 +40,7 @@ workflows:
   version: 2
   commit:
     jobs:
+      - verify-changelog
       - release-vs-ponyc-release
       - debug-vs-ponyc-release
 

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,15 @@
+# Change Log
+
+All notable changes to this project will be documented in this file. This project adheres to [Semantic Versioning](http://semver.org/) and [Keep a CHANGELOG](http://keepachangelog.com/).
+
+## [unreleased] - unreleased
+
+### Fixed
+
+
+### Added
+
+
+### Changed
+
+
diff --git a/USAGE.md b/USAGE.md
@@ -10,11 +10,14 @@ The contents of this repo are designed to get you up and running with everything
 - Contribution guide that matches Pony's.
 - Code of Conduct that matches Pony's.
 - Style Guide that matches Pony's.
+- Script to automate releasing versions of your library
+- CHANGELOG file for tracking changes to our project
 - README including:
   * CircleCI status badge
   * Project status
   * How to install using pony-stable
 
+
 You still need to add:
 
 - A License