From 6a8802cb49d96f7080371b0aef5819d9481409cb Mon Sep 17 00:00:00 2001 From: Lucas Cimon <925560+Lucas-C@users.noreply.github.com> Date: Mon, 16 Dec 2024 16:16:45 +0100 Subject: [PATCH 1/2] MAINT: Adopt allcontributors - close #82 --- .all-contributorsrc | 98 +++++++++++++++++++++++++++++++++++++++++++++ CONTRIBUTORS.md | 42 +------------------ README.md | 37 +++++++++++++++++ 3 files changed, 136 insertions(+), 41 deletions(-) create mode 100644 .all-contributorsrc diff --git a/.all-contributorsrc b/.all-contributorsrc new file mode 100644 index 0000000..452425a --- /dev/null +++ b/.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" +} diff --git a/CONTRIBUTORS.md b/CONTRIBUTORS.md index 66d710e..b1c35a3 100644 --- a/CONTRIBUTORS.md +++ b/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-). diff --git a/README.md b/README.md index a749d60..78c0fa1 100644 --- a/README.md +++ b/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 🤗 + + + + + + + + + + + + + + + + + + + +
Martin Thoma
Martin Thoma
💻 📖 🤔 🚇 🚧 📆 ✅		Lucas Cimon
Lucas Cimon
🐛 💻 📖 🚧		Rob Adams
Rob Adams
💻		Harsh
Harsh
💻		Sascha Rogmann
Sascha Rogmann
💻
Enrique Botía
Enrique Botía
💻		kommade
kommade
💻		Zingzy
Zingzy
💻
+ + + + + + +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). From 9cdebc5c133cdb40126869a565cf38fe3518d6cc Mon Sep 17 00:00:00 2001 From: Lucas Cimon <925560+Lucas-C@users.noreply.github.com> Date: Sun, 22 Dec 2024 20:35:10 +0100 Subject: [PATCH 2/2] Allowing commits from Dependabot prefixed by: 'Docs:' --- .github/scripts/check_pr_title.py | 1 + docs/dev/intro.md | 2 +- make_release.py | 2 +- 3 files changed, 3 insertions(+), 2 deletions(-) diff --git a/.github/scripts/check_pr_title.py b/.github/scripts/check_pr_title.py index e2825cd..69d4406 100644 --- a/.github/scripts/check_pr_title.py +++ b/.github/scripts/check_pr_title.py @@ -11,6 +11,7 @@ "PI: ", "ROB: ", "DOC: ", + "Docs: ", # MRs from Dependabot "TST: ", "DEV: ", "STY: ", diff --git a/docs/dev/intro.md b/docs/dev/intro.md index b58edf3..9824b93 100644 --- a/docs/dev/intro.md +++ b/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 diff --git a/make_release.py b/make_release.py index 33ed64d..66005eb 100644 --- a/make_release.py +++ b/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",