Skip to content
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Commit e538eef

Browse files
committedFeb 27, 2025·
Add pull request template
1 parent 617c8d5 commit e538eef

File tree

1 file changed

+34
-0
lines changed

1 file changed

+34
-0
lines changed
 

‎.github/pull_request_template.md

+34
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
## Scope and purpose
2+
3+
Fixes #<!-- ISSUE-ID -->. Dependent on #<!-- PULL-REQUEST-ID -->. <!-- Reference: https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue -->
4+
5+
Add a description of what this PR does and why it is needed. If a linked ticket(s) fully
6+
cover it, you can omit this.
7+
8+
<!-- remove things that do not apply -->
9+
### This pull request
10+
* adds/changes/removes a dependency
11+
* changes the database
12+
* changes the API
13+
14+
15+
## Contributor Checklist
16+
17+
Every pull request should have this checklist filled out, no matter how small it is.
18+
More information about contributing to NAV can be found in the
19+
[Hacker's guide to NAV](https://nav.readthedocs.io/en/latest/hacking/hacking.html#hacker-s-guide-to-nav).
20+
21+
<!-- Add an "X" inside the brackets to confirm -->
22+
<!-- If not checking one or more of the boxes, please explain why below each. -->
23+
24+
* [ ] Added a changelog fragment for [towncrier](https://nav.readthedocs.io/en/latest/hacking/hacking.html#adding-a-changelog-entry)
25+
* [ ] Added/amended tests for new/changed code
26+
* [ ] Added/changed documentation
27+
* [ ] Linted/formatted the code with black and ruff, easiest by using [pre-commit](https://nav.readthedocs.io/en/latest/hacking/hacking.html#pre-commit-hooks-and-black)
28+
* [ ] The first line of the commit message continues the sentence "If applied, this commit will ...", starts with a capital letter, does not end with punctuation and is 50 characters or less long. See https://cbea.ms/git-commit/
29+
* [ ] Based this on the right branch: For a patch/bugfix affecting the latest stable series based it on that series' branch (`<major>.<minor>.x`), for a new feature and other additions based them on `master`
30+
* [ ] If applicable: Created new issues if this PR does not fix the issue completely/there is further work to be done
31+
* [ ] If this results in changes in the UI: Added screenshots of the before and after
32+
* [ ] If this adds a new Python source code file: Added the [boilerplate header](https://nav.readthedocs.io/en/latest/hacking/hacking.html#python-boilerplate-headers) to that file
33+
34+
<!-- Make this a draft PR if the content is subject to change, cannot be merged or if it is for initial feedback -->

0 commit comments

Comments
 (0)
Please sign in to comment.