Merge 78a52d75ca into 614ad33a60

.github/pull_request_template.md

@@ -9,44 +9,45 @@ below this line. You may attach an issue to your pull request with `Fixes #<issu
 this comment.
 -->
 
-## Type of change
-
-<!--
-Please check all that apply. This section is not a hard requirement, but it helps prioritize critical pull requests
-for reviewers and contributors.
--->
-
-- [ ] Bug fix (**non-breaking** change which fixes an issue)
-- [ ] New feature (**non-breaking** change which adds functionality)
-- [ ] Breaking change (fix or feature that would cause existing functionality to
-      not work as expected)
-- [ ] Translation/Language update
-- [ ] Changes to module documentation or the nvf manual (`docs/manual`)
-- [ ] Other
-
 ## Sanity Checking
 
 <!--
 Please check all that apply. As before, this section is not a hard requirement but checklists with more checked
 items are likely to be merged faster. You may save some time in maintainer review by performing self-reviews here
 before submitting your pull request.
+
+If your pull request includes any change or unexpected behaviour not covered below, please do make sure to include
+it above in your description.
 -->
 
-- [ ] My code follows the style and contributing guidelines of this project.
+[editorconfig]: https://editorconfig.org
-  - [ ] I ran Alejandra to format my code (`nix fmt`).
+[changelog]: https://github.com/NotAShelf/nvf/tree/main/docs/release-notes
-  - [ ] My code conforms to the `Editorconfig` styles in the project root.
+
-- [ ] I have performed a self-review of my own code and tested it.
+- [ ] I have updated the [changelog] as per my changes.
-  - Package(s) built:
+- [ ] I have tested, and self-reviewed my code.
-    - [ ] `.#nix`
+- Style and consistency
-    - [ ] `.#maximal`
+  - [ ] I ran **Alejandra** to format my code (`nix fmt`).
-    - [ ] `.#docs-html`
+  - [ ] My code conforms to the [editorconfig] configuration of the project.
-- [ ] I have commented my code, particularly in hard-to-understand areas.
+  - [ ] My changes are consistent with the rest of the codebase.
-- [ ] My changes generate no new errors or warnings.
+- If new changes are particularly complex:
-- [ ] This change requires a documentation update.
+  - [ ] My code includes comments in particularly complex areas
-  - [ ] I have have added a change-log entry (see `docs/manual/release-notes`).
+  - [ ] I have added a section in the manual.
-  - If new changes are particularly complex:
+  - [ ] _(For breaking changes)_ I have included a migration guide.
-    - [ ] I have added a section in the manual.
+- Package(s) built:
-    - [ ] (For breaking changes) I have included a migration guide..
+  - [ ] `.#nix` (default package)
+  - [ ] `.#maximal`
+  - [ ] `.#docs-html`
+- Tested on platform(s)
+  - [ ] `x86_64-linux`
+  - [ ] `aarch64-linux`
+  - [ ] `x86_64-darwin`
+  - [ ] `aarch64-darwin`
+
+<!--
+If your changes touch upon a portion of the codebase that you do not understand well, please make sure to consult
+the maintainers on your changes. In most cases, making an issue before creating your PR will help you avoid duplicate
+efforts in the long run.
+-->
 
 ---