We (@gromakovsky and I) recently discussed tagging new definitions with a @since haddock annotation.
The problem is that we might not always remember to do that, and we end up using it rather inconsistently - thus, the annotations will not be reliable or as useful as intended.
To remedy that, I created a new PR template for release-related PRs. This has a checklist specific for release-related activities, which includes adding @since tags to all definitions introduced in that PR.
While I'm here, I also added an item to the "normal" PR template to remind devs to update the .hlint.yaml rules, and also fixed some broken links.
Related issues(s)
Fixed None
✓ 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).
[x] I made sure my PR addresses a single concern, or multiple concerns which
are inextricably linked. Otherwise I should open multiple PR's.
[x] If your PR fixes/relates to an open issue then the description should
reference this issue. See also auto linking on
github.
Related changes (conditional)
Tests
[x] If I added new functionality, I added tests covering it.
[x] 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:
[x] I added an entry to the changelog if my changes are visible to the users
and
[x] provided a migration guide for breaking changes if possible
Stylistic guide (mandatory)
[x] My commit history is clean (only contains changes relating to my
issue/pull request and no reverted-my-earlier-commit changes) and commit
messages start with identifiers of related issues in square brackets.
Example:[#42] Short commit description
If necessary both of these can be achieved even after the commits have been
made/pushed using rebase and squash.
Description
We (@gromakovsky and I) recently discussed tagging new definitions with a
@sincehaddock annotation. The problem is that we might not always remember to do that, and we end up using it rather inconsistently - thus, the annotations will not be reliable or as useful as intended.To remedy that, I created a new PR template for release-related PRs. This has a checklist specific for release-related activities, which includes adding
@sincetags to all definitions introduced in that PR.While I'm here, I also added an item to the "normal" PR template to remind devs to update the
.hlint.yamlrules, and also fixed some broken links.Related issues(s)
Fixed None
✓ 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
Documentation
I checked whether I should update the docs and did so if necessary:
Record your changes
Stylistic guide (mandatory)
[x] My commit history is clean (only contains changes relating to my issue/pull request and no reverted-my-earlier-commit changes) and commit messages start with identifiers of related issues in square brackets.
Example:
[#42] Short commit descriptionIf necessary both of these can be achieved even after the commits have been made/pushed using rebase and squash.