add description to CHANGELOG.md created by init

NiclasvanEyk · Jun 20, 2023 · 7e1617a · 7e1617a
1 parent 289eb46
commit 7e1617a
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -19,7 +19,7 @@ This section contains a few copy-pastable gists that should download and install
 curl -sL https://github.com/NiclasvanEyk/keepac/releases/latest/download/keepac_Linux_x86_64.tar.gz | tar -xz && mv changelog /usr/local/bin/ && changelog --help
 ```
 
-### MacOS - Homebrew 
+### MacOS - Homebrew
 
 ```shell
 brew install niclasvaneyk/keepac/keepac
@@ -44,6 +44,11 @@ Creates an empty `CHANGELOG.md` file in the current directory which looks someth
 ```markdown
 # 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]
 
 ### Added

diff --git a/cmd/init.go b/cmd/init.go
@@ -31,6 +31,11 @@ var initCmd = &cobra.Command{
 		changelogPath = path.Join(cwd, "CHANGELOG.md")
 		changelogContents := `# 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]
 `