Skip to content

Commit

Permalink
Add a changelog, require its maintenance
Browse files Browse the repository at this point in the history
Problem: we are going to release this tool and from that point
it would be nice to maintain its changelog.

Solution: add a simple CHANGES.md and update PR template.
  • Loading branch information
gromakovsky committed Jan 14, 2020
1 parent 0c0ccb3 commit ec9f8ba
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 0 deletions.
2 changes: 2 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
13 changes: 13 additions & 0 deletions CHANGES.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<!--
- SPDX-FileCopyrightText: 2020 Serokell <https://serokell.io>
-
- SPDX-License-Identifier: MPL-2.0
-->

Unreleased
==========

0.1.0.0
=======

Initial release.
1 change: 1 addition & 0 deletions package.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down

0 comments on commit ec9f8ba

Please sign in to comment.