Skip to content

Commit 303219d

Browse files
committed
DOC: Pull Request prefixes and size
1 parent 4aae547 commit 303219d

File tree

1 file changed

+18
-1
lines changed

1 file changed

+18
-1
lines changed

docs/dev/intro.md

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,10 +59,13 @@ BODY
5959

6060
The `PREFIX` can be:
6161

62+
* `SEC`: Security improvements. Typically an infinite loop that was possible.
6263
* `BUG`: A bug was fixed. Likely there is one or multiple issues. Then write in
6364
the `BODY`: `Closes #123` where 123 is the issue number on GitHub.
6465
It would be absolutely amazing if you could write a regression test in those
6566
cases. That is a test that would fail without the fix.
67+
A bug is always an issue for pypdf users - test code or CI that was fixed is
68+
not considered a bug here.
6669
* `ENH`: A new feature! Describe in the body what it can be used for.
6770
* `DEP`: A deprecation - either marking something as "this is going to be removed"
6871
or actually removing it.
@@ -75,7 +78,21 @@ The `PREFIX` can be:
7578
* `MAINT`: Quite a lot of different stuff. Performance improvements are for sure
7679
the most interesting changes in here. Refactorings as well.
7780
* `STY`: A style change. Something that makes pypdf code more consistent.
78-
Typically a small change.
81+
Typically a small change. It could also be better error messages for
82+
end users.
83+
84+
The prefix is used to generate the CHANGELOG. Every PR must have exactly one -
85+
if you feel like several match, take the top one from this list that matches for
86+
your PR.
87+
88+
## Pull Request Size
89+
90+
Smaller Pull Requests (PRs) are preferred as it's typically easier to merge
91+
them. For example, if you have some typos, a few code-style changes, a new
92+
feature, and a bug-fix, that could be 3 or 4 PRs.
93+
94+
A PR must be complete. That means if you introduce a new feature it must be
95+
finished within the PR and have a test for that feature.
7996

8097
## Benchmarks
8198

0 commit comments

Comments
 (0)