diff --git a/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md new file mode 100644 index 0000000..c50c5aa --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md @@ -0,0 +1,40 @@ +# Description + +A clear and concise description of the aim of your Pull Request. + +**If your pull request aims to fix an open issue or a present bug, please link the relevant issue below. If not, please remove this section** +Fixes #(issue) + +## 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 + +## Checklist + +Please try to check at least a majority of the checklist before opening your pull request. PRs +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. +- [ ] I have performed a self-review of my own code and tested it. +- [ ] I have commented my code, particularly in hard-to-understand areas. +- [ ] My changes generate no new warnings. +- [ ] This change requires a documentation update. +- [ ] I have updated the documentation accordingly. + +## 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/). + +**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 +```