From b4503b05e2562d9e690bf238c6bdb53d1d954cd0 Mon Sep 17 00:00:00 2001 From: John Hodges Date: Mon, 16 Aug 2021 10:47:35 -0400 Subject: [PATCH] Adopt Semantic Versioning --- CHANGELOG.md | 59 ++++++++++++++++++++++++++++++++++++++++++++++++++++ README.md | 2 ++ 2 files changed, 61 insertions(+) create mode 100644 CHANGELOG.md diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..09392c4 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,59 @@ +# Changelog + +All notable changes to this project will be documented in this file. + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), +and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +## [Unreleased] + +## [0.3.1] - 2021-08-02 + +### Added + +- This changelog + +### Changed + +- Add versioning badge to README +- Add step to remove contents of changelog to prevent confusion + +## [0.3.0] - 2021-07-21 + +### Added + +- Integrate stale action + +### Changed + +- Add "Before you begin" section to README + +## [0.2.1] - 2021-06-08 + +### Changed + +- Add explanation of why PR descriptions are so important + +## [0.2.0] - 2021-06-03 + +### Added + +- Pull request template +- Bug report template +- Feature request template + +## [0.1.1] - 2021-05-24 + +### Changed + +- Be more explicit about where the code of conduct applies + +## [0.1.0] - 2021-05-11 + +### Added + +- Contributor Covenant +- Contribution guidelines +- Maintainers file +- README template +- Security guidance diff --git a/README.md b/README.md index 054cf48..315b18d 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,6 @@ # OSPO Project Template +[![OSS Template Version](https://img.shields.io/badge/OSS%20Template-0.3.1-7f187f.svg)](https://github.com/wayfair-incubator/oss-template/) [![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.0-4baaaa.svg)](CODE_OF_CONDUCT.md) ## Before You Start... @@ -23,6 +24,7 @@ In trying to keep this template as generic and reusable as possible, there are s - [ ] In [`CONTRIBUTING.md`](CONTRIBUTING.md) - [ ] In [`SECURITY.md`](SECURITY.md) - [ ] Add names and contact information for actual project maintainers to [`MAINTAINERS.md`](MAINTAINERS.md) +- [ ] Delete the content of [`CHANGELOG.md`](CHANGELOG.md). We encourgage you to [keep a changelog](https://keepachangelog.com/en/1.0.0/). - [ ] Replace the generic content in this file with the relevant details about your project - [ ] Delete this section of the README