MAINT: Adopt allcontributors - close #82

.all-contributorsrc

@@ -0,0 +1,98 @@
+{
+  "projectName": "pdfly",
+  "projectOwner": "py-pdf",
+  "repoType": "github",
+  "repoHost": "https://github.com",
+  "files": [
+    "README.md"
+  ],
+  "imageSize": 100,
+  "commit": true,
+  "commitConvention": "eslint",
+  "contributors": [
+    {
+      "login": "MartinThoma",
+      "name": "Martin Thoma",
+      "avatar_url": "https://avatars.githubusercontent.com/u/1658117?v=4",
+      "profile": "http://martin-thoma.com/",
+      "contributions": [
+        "code",
+        "doc",
+        "ideas",
+        "infra",
+        "maintenance",
+        "projectManagement",
+        "tutorial"
+      ]
+    },
+    {
+      "login": "Lucas-C",
+      "name": "Lucas Cimon",
+      "avatar_url": "https://avatars.githubusercontent.com/u/925560?v=4",
+      "profile": "https://chezsoi.org/lucas/blog/",
+      "contributions": [
+        "bug",
+        "code",
+        "doc",
+        "maintenance"
+      ]
+    },
+    {
+      "login": "pastor-robert",
+      "name": "Rob Adams",
+      "avatar_url": "https://avatars.githubusercontent.com/u/35646090?v=4",
+      "profile": "https://github.com/pastor-robert",
+      "contributions": [
+        "code"
+      ]
+    },
+    {
+      "login": "Kaos599",
+      "name": "Harsh ",
+      "avatar_url": "https://avatars.githubusercontent.com/u/115716485?v=4",
+      "profile": "https://github.com/Kaos599",
+      "contributions": [
+        "code"
+      ]
+    },
+    {
+      "login": "srogmann",
+      "name": "Sascha Rogmann",
+      "avatar_url": "https://avatars.githubusercontent.com/u/59577610?v=4",
+      "profile": "https://github.com/srogmann",
+      "contributions": [
+        "code"
+      ]
+    },
+    {
+      "login": "ebotiab",
+      "name": "Enrique Botía",
+      "avatar_url": "https://avatars.githubusercontent.com/u/62219950?v=4",
+      "profile": "https://github.com/ebotiab",
+      "contributions": [
+        "code"
+      ]
+    },
+    {
+      "login": "kommade",
+      "name": "kommade",
+      "avatar_url": "https://avatars.githubusercontent.com/u/99523586?v=4",
+      "profile": "https://github.com/kommade",
+      "contributions": [
+        "code"
+      ]
+    },
+    {
+      "login": "Zingzy",
+      "name": "Zingzy",
+      "avatar_url": "https://avatars.githubusercontent.com/u/90309290?v=4",
+      "profile": "https://spoo.me/",
+      "contributions": [
+        "code"
+      ]
+    }
+  ],
+  "contributorsPerLine": 5,
+  "skipCi": true,
+  "commitType": "docs"
+}

.github/scripts/check_pr_title.py

@@ -11,6 +11,7 @@
     "PI: ",
     "ROB: ",
     "DOC: ",
+    "Docs: ",  # MRs from Dependabot
     "TST: ",
     "DEV: ",
     "STY: ",

CONTRIBUTORS.md

@@ -1,41 +1 @@
-# Contributors
-
-pdfly is a free software project without any company affiliation. We cannot pay
-contributors, but we do value their contributions 🤗
-
-The list might not be complete. You can find more contributors via the git
-history and [GitHubs 'Contributors' feature](https://github.com/py-pdf/pdfly/graphs/contributors).
-
-## Contributors to the pdfly project
-
-* [Thoma, Martin](https://github.com/MartinThoma): Creator of pdfly. [LinkedIn](https://www.linkedin.com/in/martin-thoma/) | [StackOverflow](https://stackoverflow.com/users/562769/martin-thoma) | [Blog](https://martin-thoma.com/)
-
-## 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 pdfly have the last call on that one.
-* Community work: This is exceptional. If the maintainers of pdfly see people
-  being super helpful in answering issues / discussions or being very active on
-  Stackoverflow, we also consider them being contributors to pdfly.
-
-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.
+The list of contributors has been moved into the [README.md](README.md#contributors-).

README.md

@@ -64,3 +64,40 @@ $ pdfly 2-up --help
 │ --help          Show this message and exit.                                 │
 ╰─────────────────────────────────────────────────────────────────────────────╯
 ```
+
+## Contributors ✨
+
+pdfly is a free software project without any company affiliation. We cannot pay
+contributors, but we do value their contributions 🤗
+
+<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
+<!-- prettier-ignore-start -->
+<!-- markdownlint-disable -->
+<table>
+  <tbody>
+    <tr>
+      <td align="center" valign="top" width="20%"><a href="http://martin-thoma.com/"><img src="https://avatars.githubusercontent.com/u/1658117?v=4?s=100" width="100px;" alt="Martin Thoma"/><br /><sub><b>Martin Thoma</b></sub></a><br /><a href="https://github.com/py-pdf/pdfly/commits?author=MartinThoma" title="Code">💻</a> <a href="https://github.com/py-pdf/pdfly/commits?author=MartinThoma" title="Documentation">📖</a> <a href="#ideas-MartinThoma" title="Ideas, Planning, & Feedback">🤔</a> <a href="#infra-MartinThoma" title="Infrastructure (Hosting, Build-Tools, etc)">🚇</a> <a href="#maintenance-MartinThoma" title="Maintenance">🚧</a> <a href="#projectManagement-MartinThoma" title="Project Management">📆</a> <a href="#tutorial-MartinThoma" title="Tutorials">✅</a></td>
+      <td align="center" valign="top" width="20%"><a href="https://chezsoi.org/lucas/blog/"><img src="https://avatars.githubusercontent.com/u/925560?v=4?s=100" width="100px;" alt="Lucas Cimon"/><br /><sub><b>Lucas Cimon</b></sub></a><br /><a href="https://github.com/py-pdf/pdfly/issues?q=author%3ALucas-C" title="Bug reports">🐛</a> <a href="https://github.com/py-pdf/pdfly/commits?author=Lucas-C" title="Code">💻</a> <a href="https://github.com/py-pdf/pdfly/commits?author=Lucas-C" title="Documentation">📖</a> <a href="#maintenance-Lucas-C" title="Maintenance">🚧</a></td>
+      <td align="center" valign="top" width="20%"><a href="https://github.com/pastor-robert"><img src="https://avatars.githubusercontent.com/u/35646090?v=4?s=100" width="100px;" alt="Rob Adams"/><br /><sub><b>Rob Adams</b></sub></a><br /><a href="https://github.com/py-pdf/pdfly/commits?author=pastor-robert" title="Code">💻</a></td>
+      <td align="center" valign="top" width="20%"><a href="https://github.com/Kaos599"><img src="https://avatars.githubusercontent.com/u/115716485?v=4?s=100" width="100px;" alt="Harsh "/><br /><sub><b>Harsh </b></sub></a><br /><a href="https://github.com/py-pdf/pdfly/commits?author=Kaos599" title="Code">💻</a></td>
+      <td align="center" valign="top" width="20%"><a href="https://github.com/srogmann"><img src="https://avatars.githubusercontent.com/u/59577610?v=4?s=100" width="100px;" alt="Sascha Rogmann"/><br /><sub><b>Sascha Rogmann</b></sub></a><br /><a href="https://github.com/py-pdf/pdfly/commits?author=srogmann" title="Code">💻</a></td>
+    </tr>
+    <tr>
+      <td align="center" valign="top" width="20%"><a href="https://github.com/ebotiab"><img src="https://avatars.githubusercontent.com/u/62219950?v=4?s=100" width="100px;" alt="Enrique Botía"/><br /><sub><b>Enrique Botía</b></sub></a><br /><a href="https://github.com/py-pdf/pdfly/commits?author=ebotiab" title="Code">💻</a></td>
+      <td align="center" valign="top" width="20%"><a href="https://github.com/kommade"><img src="https://avatars.githubusercontent.com/u/99523586?v=4?s=100" width="100px;" alt="kommade"/><br /><sub><b>kommade</b></sub></a><br /><a href="https://github.com/py-pdf/pdfly/commits?author=kommade" title="Code">💻</a></td>
+      <td align="center" valign="top" width="20%"><a href="https://spoo.me/"><img src="https://avatars.githubusercontent.com/u/90309290?v=4?s=100" width="100px;" alt="Zingzy"/><br /><sub><b>Zingzy</b></sub></a><br /><a href="https://github.com/py-pdf/pdfly/commits?author=Zingzy" title="Code">💻</a></td>
+    </tr>
+  </tbody>
+</table>
+
+<!-- markdownlint-restore -->
+<!-- prettier-ignore-end -->
+
+<!-- ALL-CONTRIBUTORS-LIST:END -->
+
+This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification
+([emoji key](https://allcontributors.org/docs/en/emoji-key)).
+Contributions of any kind welcome!
+
+The list might not be complete. You can find more contributors via the git
+history and [GitHubs 'Contributors' feature](https://github.com/py-pdf/pdfly/graphs/contributors).

docs/dev/intro.md

@@ -56,7 +56,7 @@ The `PREFIX` can be:
 * `PI`: A performance improvement. This could also be a reduction in the
         file size of PDF files generated by pdfly.
 * `ROB`: A robustness change. Dealing better with broken PDF files.
-* `DOC`: A documentation change.
+* `DOC`: A documentation change. `Docs:` is also allowed for commits made by DependaBot.
 * `TST`: Adding or adjusting tests.
 * `DEV`: Developer experience improvements, e.g. pre-commit or setting up CI.
 * `MAINT`: Quite a lot of different stuff. Performance improvements are for sure

make_release.py

@@ -218,7 +218,7 @@ def get_formatted_changes(git_tag: str) -> Tuple[str, str]:
         "PI",
         "BUG",
         "ROB",
-        "DOC",
+        "DOC",  # We ignore MRs from Dependabot prefixed with: "Docs:"
         "DEV",
         "CI",
         "MAINT",