diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index ca65c8b..d1bfe69 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,39 +1,56 @@ -# Description + ## Type of change -Please delete any options that are not relevant. + -- 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 -- Docs -- Other +- [ ] 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 -## Checklist +## Sanity Checking -Please try to check at least a majority of the checklist before opening your pull request. Exceptions to this will be reviewed on a case by case basis. + - [ ] My code follows the style and contributing guidelines of this project. -- [ ] I ran Alejandra to format my code (`nix fmt`). + - [ ] I ran Alejandra to format my code (`nix fmt`). + - [ ] My code conforms to the `Editorconfig` styles in the project root. - [ ] I have performed a self-review of my own code and tested it. + - Package(s) built: + - [ ] `.#nix` + - [ ] `.#maximal` + - [ ] `.#docs-html` - [ ] I have commented my code, particularly in hard-to-understand areas. -- [ ] My changes generate no new warnings. +- [ ] My changes generate no new errors or warnings. - [ ] This change requires a documentation update. -- [ ] I have updated the documentation accordingly. + - [ ] I have have added a change-log entry (see `docs/manual/release-notes`). + - If new changes are particularly complex: + - [ ] I have added a section in the manual. + - [ ] (For breaking changes) I have included a migration guide.. -## Screenshots & Logs +--- -You are kindly requested to attach screenshots of your changes in actions and preferably your build/run logs for all available packages. If you are not sure how to do this, you can refer to the [documentation](https://notashelf.github.io/neovim-flake/). +Add a :+1: [reaction] to [pull requests you find important]. -**Please do not use any external image service. Instead, just paste in or drag and drop the image here, and it will be uploaded automatically.** - -```console -# Paste your logs here -``` +[reaction]: https://github.blog/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/ +[pull requests you find important]: https://github.com/NixOS/nixpkgs/pulls?q=is%3Aopen+sort%3Areactions-%2B1-desc