mirror of
https://github.com/serokell/xrefcheck.git
synced 2024-08-17 09:30:35 +03:00
63 lines
2.6 KiB
Markdown
63 lines
2.6 KiB
Markdown
## 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).
|
|
-->
|
|
|
|
Fixes #
|
|
|
|
## :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:
|
|
- [README](https://github.com/serokell/xrefcheck/tree/master/README.md)
|
|
- 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.
|
|
- [ ] I added an entry to the [changelog](https://github.com/serokell/xrefcheck/tree/master/CHANGES.md) if my changes are visible to the users
|
|
and
|
|
- [ ] 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).
|
|
- [ ] My code complies with the [style guide](https://github.com/serokell/style/blob/master/haskell.md).
|
|
|
|
#### ✓ 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.
|
|
- [ ] (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.
|
|
- [ ] (After merging) I updated [`xrefcheck-action`](https://github.com/serokell/xrefcheck-action#updating-supported-versions).
|
|
- [ ] (After merging) I uploaded the package to [hackage](https://hackage.haskell.org/package/xrefcheck).
|