meta: improve github pull request template

This commit is contained in:
raf 2024-10-06 01:16:18 +03:00
parent f01e404b2e
commit 379d2a9f16
Signed by: NotAShelf
GPG key ID: AF26552424E53993

View file

@ -1,39 +1,44 @@
# Description <!--
^ Please include a clear and concise description of the aim of your Pull Request above this line ^
A clear and concise description of the aim of your Pull Request. For plugin dependency/module additions, please make sure to link the source link of the added plugin
or dependency in this section.
**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** If your pull request aims to fix an open issue or a please bug, please also link the relevant issue
Fixes #(issue) below this line. You may attach an issue to your pull request with `Fixes #<issue number>` outside
this comment.
-->
## Type of change ## Sanity Checking
Please delete any options that are not relevant. <!--
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.
-->
- Bug fix (non-breaking change which fixes an issue) [editorconfig]: https://editorconfig.org
- 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 - Style and consistency
- [ ] I ran **Alejandra** to format my code (`nix fmt`).
- [ ] My code conforms to the [editorconfig] configuration of the project.
- [ ] My changes are consistent with the rest of the codebase.
- If new changes are particularly complex:
- [ ] My code includes comments in particularly complex areas
- [ ] I have added a section in the manual.
- [ ] _(For breaking changes)_ I have included a migration guide.
- Package(s) built:
- [ ] `.#nix` (default package)
- [ ] `.#maximal`
- [ ] `.#docs-html`
- Tested on platform(s)
- [ ] `x86_64-linux`
- [ ] `aarch64-linux`
- [ ] `x86_64-darwin`
- [ ] `aarch64-darwin`
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. <!--
If your changes touch upon a portion of the codebase that you do not understand well, please make sure to consult
- [ ] My code follows the style and contributing guidelines of this project. the maintainers on your changes. In most cases, making an issue before creating your PR will help you avoid duplicate
- [ ] I ran Alejandra to format my code (`nix fmt`). efforts in the long run.
- [ ] 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
```