Skip to content

Commit

Permalink
DOC: Contributors file (#1132)
Browse files Browse the repository at this point in the history
We value the work of our contributors - of all of them. The CONTRIBUTORS file might give them more visibility and be more robust when the project is vendored into other projects.

It is by far not complete - I hope that people add themselves in PRs :-) 

See #798
  • Loading branch information
MartinThoma authored Jul 20, 2022
1 parent f2983e1 commit c63a0ff
Show file tree
Hide file tree
Showing 3 changed files with 50 additions and 0 deletions.
48 changes: 48 additions & 0 deletions CONTRIBUTORS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
# Contributors

PyPDF2 had a lot of contributors since it started with pyPdf in 2005. We are
a free software project without any company affiliation. We cannot pay
contributors, but we do value their contributions. A lot of time, effort, and
expertise went into this project. With this list, we recognize those awesome
people 🤗

The list is definitely not complete. You can find more contributors via the git
history and [GitHubs 'Contributors' feature](https://github.com/py-pdf/PyPDF2/graphs/contributors).

## Contributors to the pyPdf / PyPDF2 project

* [Karvonen, Harry](https://github.com/Hatell/)
* [Pinheiro, Arthur](https://github.com/xilopaint)
* [pubpub-zz](https://github.com/pubpub-zz): involved in community development
* [Thoma, Martin](https://github.com/MartinThoma): Maintainer of PyPDF2 since April 2022. I hope to build a great community with many awesome contributors. [LinkedIn](https://www.linkedin.com/in/martin-thoma/) | [StackOverflow](https://stackoverflow.com/users/562769/martin-thoma) | [Blog](https://martin-thoma.com/)
* ztravis

## Adding a new contributor

Contributors are:

* Anybody who has an commit in main - no matter how big/small or how many. Also if it's via co-authored-by.
* People who opened helpful issues:
(1) Bugs: with complete MCVE
(2) Well-described feature requests
(3) Potentially some more.
The maintainers of PyPDF2 have the last call on that one.
* Community work: This is exceptional. If the maintainers of PyPDF2 see people
being super helpful in answering issues / discussions or being very active on
Stackoverflow, we also consider them being contributors to PyPDF2.

Contributors can add themselves or ask via an Github Issue to be added.

Please use the following format:

```
* Last name, First name: 140-characters of text; links to linkedin / github / other profiles and personal pages are ok
OR
* GitHub Username: 140-characters of text; links to linkedin / github / other profiles and personal pages are ok
```

and add the entry in the alphabetical order. People who . The 140 characters are everything visible after the `Name:`.

Please don't use images.
1 change: 1 addition & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@
sys.path.insert(0, os.path.abspath("../"))

shutil.copyfile("../CHANGELOG.md", "meta/CHANGELOG.md")
shutil.copyfile("../CONTRIBUTORS.md", "meta/CONTRIBUTORS.md")

# -- Project information -----------------------------------------------------

Expand Down
1 change: 1 addition & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,7 @@ You can contribute to `PyPDF2 on Github <https://github.com/py-pdf/PyPDF2>`_.
meta/CHANGELOG
meta/project-governance
meta/history
meta/CONTRIBUTORS
meta/comparisons
meta/faq

Expand Down

0 comments on commit c63a0ff

Please sign in to comment.