Merge pull request #18 from serokell/gromak/int111-changelog

Add a changelog, require its maintenance
serokell · Jan 14, 2020 · b54c38d · b54c38d
2 parents 0c0ccb3 + ec9f8ba
commit b54c38d
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 0 deletions.
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
@@ -38,6 +38,8 @@ checkmark indicating that you are sure it is dealt with (be that by irrelevance)
 - Public contracts
   - [ ] Any modifications of public contracts comply with the [Evolution
   of Public Contracts](https://www.notion.so/serokell/Evolution-of-Public-Contracts-2a3bf7971abe4806a24f63c84e7076c5) policy.
+  - [ ] I added an entry to the [changelog](/CHANGES.md) if my changes are visible to the users
+        and
   - [ ] provided a migration guide for breaking changes if possible
 
 #### Stylistic guide (mandatory)

diff --git a/CHANGES.md b/CHANGES.md
@@ -0,0 +1,13 @@
+<!--
+ - SPDX-FileCopyrightText: 2020 Serokell <https://serokell.io>
+ -
+ - SPDX-License-Identifier: MPL-2.0
+ -->
+
+Unreleased
+==========
+
+0.1.0.0
+=======
+
+Initial release.
diff --git a/package.yaml b/package.yaml
@@ -13,6 +13,7 @@ copyright:           2018-2019 Serokell <https://serokell.io>
 
 extra-source-files:
 - README.md
+- CHANGES.md
 - src-files/*
 
 description:         Please see the README on GitHub at <https://github.com/serokell/xrefcheck#readme>