2019-03-14 20:21:20 +03:00
## Description
<!--
Describes the nature of your changes. If they are substantial, you should
further subdivide this into a section describing the problem you are solving and
another describing your solution.
-->
## Related issue(s)
<!--
- Short description of how the PR relates to the issue, including an issue link.
For example
- Fixed #1 by adding lenses to exported items
Write 'None' if there are no related issues (which is discouraged).
-->
2022-07-22 18:53:20 +03:00
Fixes #
2019-03-14 20:21:20 +03:00
## :white_check_mark: Checklist for your Pull Request
Ideally a PR has all of the checkmarks set.
If something in this list is irrelevant to your PR, you should still set this
checkmark indicating that you are sure it is dealt with (be that by irrelevance).
#### Related changes (conditional)
- Tests
- [ ] If I added new functionality, I added tests covering it.
- [ ] If I fixed a bug, I added a regression test to prevent the bug from
silently reappearing again.
- Documentation
- [ ] I checked whether I should update the docs and did so if necessary:
2022-09-21 13:10:07 +03:00
- [README ](https://github.com/serokell/xrefcheck/tree/master/README.md )
2019-03-14 20:21:20 +03:00
- Haddock
- 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.
2022-09-21 13:10:07 +03:00
- [ ] I added an entry to the [changelog ](https://github.com/serokell/xrefcheck/tree/master/CHANGES.md ) if my changes are visible to the users
2020-01-14 20:22:20 +03:00
and
2019-03-14 20:21:20 +03:00
- [ ] provided a migration guide for breaking changes if possible
#### Stylistic guide (mandatory)
- [ ] My commits comply with [the policy used in Serokell ](https://www.notion.so/serokell/Where-and-how-to-commit-your-work-58f8973a4b3142c8abbd2e6fd5b3a08e ).
2022-09-21 13:10:07 +03:00
- [ ] My code complies with the [style guide ](https://github.com/serokell/style/blob/master/haskell.md ).
2022-09-21 13:14:01 +03:00
#### ✓ Release Checklist
- [ ] I updated the version number in `package.yaml` .
- [ ] I updated the [changelog ](https://github.com/serokell/xrefcheck/tree/master/CHANGES.md ) and moved everything
under the "Unreleased" section to a new section for this release version.
2022-09-24 15:33:51 +03:00
- [ ] (After merging) I edited the [auto-release ](https://github.com/serokell/xrefcheck/releases/tag/auto-release ).
* Change the tag and title using the format `vX.Y.Z` .
* Write a summary of all user-facing changes.
* Deselect the "This is a pre-release" checkbox at the bottom.
2022-09-23 14:21:30 +03:00
- [ ] (After merging) I updated [`xrefcheck-action` ](https://github.com/serokell/xrefcheck-action#updating-supported-versions ).
2022-09-26 21:32:40 +03:00
- [ ] (After merging) I uploaded the package to [hackage ](https://hackage.haskell.org/package/xrefcheck ).