From 4b20e50ee585276eab7454a2488da8e540805077 Mon Sep 17 00:00:00 2001 From: Floris Bruynooghe Date: Mon, 13 Jan 2025 12:51:21 +0100 Subject: [PATCH] chore: Remove checkboxes from PR templates A significant number of our own PRs don't bother with the checkboxes. This makes it hard to enforce (I've tried!) and does not give us anything to ask from external contributors either. I'm also often torn what to do with non-applicable items, I've tried all of: - Remove them. Weird. - Strike them out, not so weird, but so much effort. - Tick off even if not-applicable (my current approache), also weird. So instead of bothering the humans I'm adapting to their behaviour. An alternative I could live with would be enforce this by machines: Have a required CI check that needs the checkboxes ticked off so that you can not merge a PR while ignoring this. Maybe with some more guidance on what to do if not applicable. --- .github/pull_request_template.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 6cc5a1f3eef..6f382de37dc 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -12,7 +12,9 @@ ## Change checklist -- [ ] Self-review. -- [ ] Documentation updates following the [style guide](https://rust-lang.github.io/rfcs/1574-more-api-documentation-conventions.html#appendix-a-full-conventions-text), if relevant. -- [ ] Tests if relevant. -- [ ] All breaking changes documented. +Please make sure to consider all of these: + +- Self-review. +- Documentation updates following the [style guide](https://rust-lang.github.io/rfcs/1574-more-api-documentation-conventions.html#appendix-a-full-conventions-text). +- Tests. +- Document breaking changes.