mirror of
https://github.com/NotAShelf/nvf.git
synced 2025-01-30 22:02:23 +00:00
meta: include hacking guidelines in PR template
This commit is contained in:
parent
4b6021073c
commit
38e57c8248
1 changed files with 12 additions and 5 deletions
|
@ -7,14 +7,17 @@ or dependency in this section.
|
|||
If your pull request aims to fix an open issue or a please bug, please also link the relevant issue
|
||||
below this line. You may attach an issue to your pull request with `Fixes #<issue number>` outside
|
||||
this comment, and it will be closed when your pull request is merged.
|
||||
|
||||
A developer package template is provided in flake/develop.nix. If working on a module, you may use
|
||||
it to test your changes with minimal dependency changes.
|
||||
-->
|
||||
|
||||
## 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.
|
||||
items are likely to be merged faster. You may save some time in maintainer reviews 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.
|
||||
|
@ -22,9 +25,11 @@ it above in your description.
|
|||
|
||||
[editorconfig]: https://editorconfig.org
|
||||
[changelog]: https://github.com/NotAShelf/nvf/tree/main/docs/release-notes
|
||||
[hacking nvf]: https://notashelf.github.io/nvf/index.xhtml#sec-guidelines
|
||||
|
||||
- [ ] I have updated the [changelog] as per my changes
|
||||
- [ ] I have tested, and self-reviewed my code
|
||||
- [ ] My changes fit guidelines found in [hacking nvf]
|
||||
- Style and consistency
|
||||
- [ ] I ran **Alejandra** to format my code (`nix fmt`)
|
||||
- [ ] My code conforms to the [editorconfig] configuration of the project
|
||||
|
@ -34,9 +39,10 @@ it above in your description.
|
|||
- [ ] I have added a section in the manual
|
||||
- [ ] _(For breaking changes)_ I have included a migration guide
|
||||
- Package(s) built:
|
||||
- [ ] `.#nix` (default package)
|
||||
- [ ] `.#nix` _(default package)_
|
||||
- [ ] `.#maximal`
|
||||
- [ ] `.#docs-html` (manual, must build)
|
||||
- [ ] `.#docs-html` _(manual, must build)_
|
||||
- [ ] `.#docs-linkcheck` _(optional, please build if adding links)_
|
||||
- Tested on platform(s)
|
||||
- [ ] `x86_64-linux`
|
||||
- [ ] `aarch64-linux`
|
||||
|
@ -46,7 +52,8 @@ it above in your description.
|
|||
<!--
|
||||
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.
|
||||
efforts in the long run. `git blame` might help you find out who is the "author" or the "maintainer" of a current
|
||||
module by showing who worked on it the most.
|
||||
-->
|
||||
|
||||
---
|
||||
|
|
Loading…
Reference in a new issue