Skip to content

Commit

Permalink
DOC: Explanation for git submodule
Browse files Browse the repository at this point in the history
  • Loading branch information
MartinThoma committed Jul 17, 2022
1 parent b1d4ea1 commit 8a010a5
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions docs/dev/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,12 @@ most cases we typically want to test for. The `sample-files` might cover a lot
more edge cases, the behavior we get when file sizes get bigger, different
PDF producers.

In order to get the sample-files folder, you need to execute:

```
git submodule update --init
```

## Tools: git and pre-commit

Git is a command line application for version control. If you don't know it,
Expand Down Expand Up @@ -67,6 +73,8 @@ The `PREFIX` can be:
* `ENH`: A new feature! Describe in the body what it can be used for.
* `DEP`: A deprecation - either marking something as "this is going to be removed"
or actually removing it.
* `PI`: A performance improvement. This could also be a reduction in the
file size of PDF files generated by PyPDF2.
* `ROB`: A robustness change. Dealing better with broken PDF files.
* `DOC`: A documentation change.
* `TST`: Adding / adjusting tests.
Expand Down

0 comments on commit 8a010a5

Please sign in to comment.