From 519bc3a45fee4f32dc26aaff3280ccbde3ac3d71 Mon Sep 17 00:00:00 2001 From: Stefan Kolb Date: Mon, 11 Jan 2021 07:10:56 +0100 Subject: [PATCH] Link to GitHub contributors in about dialog (#7319) Co-authored-by: Oliver Kopp --- .gitattributes | 3 - .github/workflows/tests.yml | 32 --- .mailmap | 217 ------------------ DEVELOPERS => MAINTAINERS | 0 build.gradle | 3 +- docs/contributing.md | 12 +- scripts/generate-authors.sh | 62 ----- .../java/org/jabref/gui/help/AboutDialog.css | 4 + .../java/org/jabref/gui/help/AboutDialog.fxml | 15 +- .../org/jabref/gui/help/AboutDialogView.java | 6 + .../jabref/gui/help/AboutDialogViewModel.java | 27 +-- .../java/org/jabref/logic/util/BuildInfo.java | 6 +- src/main/resources/build.properties | 3 +- src/main/resources/l10n/JabRef_en.properties | 5 +- 14 files changed, 36 insertions(+), 359 deletions(-) delete mode 100644 .mailmap rename DEVELOPERS => MAINTAINERS (100%) delete mode 100755 scripts/generate-authors.sh diff --git a/.gitattributes b/.gitattributes index d37562eb76a..7752b0e534a 100644 --- a/.gitattributes +++ b/.gitattributes @@ -5,9 +5,6 @@ gradlew text eol=lf # windows line endings at windows files *.bat text eol=crlf -# required for proper releasing -AUTHORS text eol=lf - # ensure that line endings of *.java, and *.properties are normalized *.java text *.properties text diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml index 5651082269f..baec5d74a3e 100644 --- a/.github/workflows/tests.yml +++ b/.github/workflows/tests.yml @@ -232,35 +232,3 @@ jobs: steps: - uses: actions/checkout@v2 - uses: gradle/wrapper-validation-action@v1 - checkauthors: - name: "Validate AUTHORS" - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@v2 - with: - # full checkout needed for authors generation - fetch-depth: 0 - - name: "All authors of this PR listed in AUTHORS" - id: authors_check - shell: bash - run: | - git config user.name "JabRef Author Checker [bot]" - git config user.email "noreply@jabref.org" - ./scripts/generate-authors.sh - set +o pipefail - added=$(git diff HEAD --no-ext-diff --unified=0 -a --no-prefix | egrep "^\+[^+]" | sed "s/^\+//") - if [ -z "$added" ]; then - echo "No authors added" - exit 0 - fi - echo "Authors found in this PR not listed in the AUTHORS file." - echo - echo "The JabRef maintainers will add the following name to the AUTHORS file" - echo - echo -e "$added" - echo - echo "In case you want to use a different one, please comment here and adjust your name in your git configuration for future commits" - echo - echo "Just adding yourself into the AUTHORS file does not help as it is overwritten by our script ./scripts/generate-authors." - echo "Read more on the AUTHORS file at found at https://github.com/JabRef/jabref/blob/master/CONTRIBUTING.md#author-credits" - exit 1 diff --git a/.mailmap b/.mailmap deleted file mode 100644 index 9df1d2ee595..00000000000 --- a/.mailmap +++ /dev/null @@ -1,217 +0,0 @@ - -# Generate AUTHORS: scripts/generate-authors.sh - -# Tip for finding duplicates (besides scanning the output of AUTHORS for name -# duplicates that aren't also email duplicates): scan the output of: -# git log --format='%aE - %aN' | sort --unique --ignore-case -# -# One can find out the real name by using the GitHub user page and API. -# https://github.com/sauliusg -# https://api.github.com/users/sauliusg/events/public -# -# For explanation on this file format: man git-shortlog -Ruy Minoru Ito Takata -Ruy Minoru Ito Takata <21537850814@serpro-1557637.(none)> -Stefan Kolb - -Nicolas Pavillon - -Koji Yokota -Koji Yokota -Koji Yokota -Koji Yokota -Koji Yokota -Dominik Waßenhoven - -Thomas Arildsen ThomasArildsen -Thomas Arildsen ThomasA -Thomas Arildsen -Thomas Arildsen -Tobias Diez - - - - - - - -Waluyo Adi Siswanto -Michael Falkenthal -Michael Falkenthal -Ambrogio Oliva -Ambrogio Oliva -Eduardo Greco -Daniel Bruehl -Egon Willighagen -Frédéric Darboux -Frédéric Darboux -Frédéric Darboux -Frédéric Darboux -Frédéric Darboux -Florian Straßer -Gregor Herrmann -Hakan Duran hakova -Hakan Duran hakova -Hakan Duran Hakan E. Duran -Jorge Tornero -Mark Schenk -Nathan Sheffield -Oscar Gustafsson -Renato Massao -Lorenzo Genta -Morten Alver -Morten Alver -Morten Alver -Oliver Kopp -Oliver Kopp -Oliver Kopp -Oliver Kopp -Oliver Kopp -Oliver Kopp Apple Inc -Nizar N. Batada -Christopher Oezbek -Andreas Rudert -Michael Spiegel -Jörg Wegner -Michael Wrighton -Jörg Zieren -Brian Van Essen -Luciana de Melo e Abud -Seb Wills -Waluyo Adi Siswanto -Dale Visser -Erik Putrycz -Gert Renckens -Guillaume Gardey -Kolja Brix -Raik Nagel -Carlos Silla -S M Mahbub Murshed -Robert Jäschke -Ulrik Stervbo -Stefano Gariazzo -Lee Patton -Jörg Lenhard -Jörg Lenhard -Jörg Lenhard -Jörg Lenhard -Matthias Geiger -Christoph Braun -Felix Wilke -Dennis Tschechlov -Dennis Tschechlov -Christian Bartsch -Joshua Ramon Enslin -Vincent W. Yang -Jorge Tornero -Mélanie Tremblay -Christoph Schwentker -Christoph Schwentker -Jens Döcke -Jürgen Lange -Sascha Zeller -Ali Ayan -Ali Zhagparov -Ali Zhagparov -Arno Blouin -Jeff Miller -Alain Vaucher -Daniel Mair -Sven Jäger -Tim van Rossum -Saulius Gražulis -Rolf Starre -Owen Huang -Anita Armbruster -Fabian Bauer <125m125@users.noreply.github.com> -Jong-Ho Shinn -Nadeem Mahmood -Foivos Christoulakis -Predrag Milanovic -Karsten Hiekmann -Karsten Hiekmann -Andrew Levit -Berk Gureken -Abhishek Rai -Abhishek Rai -Stéphane Curet -Erdem Derebasoglu -Domenico Cufalo -Tobias Bouschen -József Pallagi -Mattia Bunel -Waida Fan <31742543+weidafan@users.noreply.github.com> -Johannes Manner -Dominik Traczyk -Cerrianne Santos -Stefan Scheffel -Stefan Gerzmann -Deepak Kumar -Aman Jain -Ayachi Nene <1710082010@qq.com> -Jan Schäfer -Stefan Scheffel -Stefan Scheffel -Yash Kothari -Quentin Fritz <49909555+core-master@users.noreply.github.com> -Daniel Rodrigues -Malte Deiseroth -Malik Atalla <6626492+HerrAachen@users.noreply.github.com> -Kaique Komata -S. Krause -Leonhard Wolz -Manuel Wtfjoke -Valentin Pons -Arthur Fröhlich <37243770+znuznu@users.noreply.github.com> -Songyu Wang <36670132+Songyu-Wang@users.noreply.github.com> -Alex Tarrix -Samiya Caur -Stanley Foerster -Michael McCann -Robin Lichtenthaeler -Rodrigo Paula da Silva -Robert Jäschke -Nick S. Weatherley -Nivedha Sunderraj -Lavabit -Rachel Wu <46014322+rachelwu21@users.noreply.github.com> -Abraham Polk -dima -Fred Stevens -Rui Kang <1539678784@qq.com> -Yurick Honda -Yurick Honda <32721326+yurickyh@users.noreply.github.com> -Mihu <41503450+mmihuu@users.noreply.github.com> -Michael Schwarmi -Michal Rican -Param Mittal -Victor Michelan -P4trice <34972281+P4trice@users.noreply.github.com> -Julien Bénard <50318255+Julien29121998@users.noreply.github.com> -Alexsandro Lauber -Alexander Girgis <11259344+AlexanderGirgis@users.noreply.github.com> -Christoph Treude -Goutam Lavudiya -Shikun Xiong <53288073+ShikunXiong@users.noreply.github.com> -Fabiani Giovanni -Dimitra Karadima <44123133+dimitra-karadima@users.noreply.github.com> -Dimitra Karadima <44123133+dimitra-karadima@users.noreply.github.com> -Cai Zhichun <54977532+braincident@users.noreply.github.com> -Gennadiy Stakhovskiy -Mootez Saad <34676841+MootezSaaD@users.noreply.github.com> -Mootez Saad <34676841+MootezSaaD@users.noreply.github.com> -Chen Yuheng -Dominik Voigt <43381984+DominikVoigt@users.noreply.github.com> -Carl Christian Snethlage <50491877+calixtus@users.noreply.github.com> -Daniel Price <64694785+daniel-price@users.noreply.github.com> -Cai Zhichun <54977532+braincident@users.noreply.github.com> <569120128@qq.com> -Hollyqqqqq <55199983+Hollyqqqqq@users.noreply.github.com> <11712639@mail.sustech.edu.cn> -Grzegorz Popiel -Tianjian Lei <185049857@qq.com> -Tianjian Lei <185049857@qq.com> -Muhammad Arsalan Badar -ZhouSky <11711923@mail.sustech.edu.cn> -Vincent Gagnon -Tom Warnke -Eric Lau <919023+skeric@users.noreply.github.com> -Isabel Beckenbach <68125288+ibe-314@users.noreply.github.com> diff --git a/DEVELOPERS b/MAINTAINERS similarity index 100% rename from DEVELOPERS rename to MAINTAINERS diff --git a/build.gradle b/build.gradle index 75fe1c3006a..3697c63d3ef 100644 --- a/build.gradle +++ b/build.gradle @@ -269,8 +269,7 @@ processResources { filesMatching("build.properties") { expand(version: project.findProperty('projVersionInfo') ?: '100.0.0', "year": String.valueOf(Calendar.getInstance().get(Calendar.YEAR)), - "authors": new File('AUTHORS').readLines().findAll { !it.startsWith("#") }.join(", "), - "developers": new File('DEVELOPERS').readLines().findAll { !it.startsWith("#") }.join(", "), + "maintainers": new File('MAINTAINERS').readLines().findAll { !it.startsWith("#") }.join(", "), "azureInstrumentationKey": System.getenv('AzureInstrumentationKey'), "springerNatureAPIKey": System.getenv('SpringerNatureAPIKey'), "astrophysicsDataSystemAPIKey": System.getenv('AstrophysicsDataSystemAPIKey'), diff --git a/docs/contributing.md b/docs/contributing.md index ca4650cedab..66084cdb692 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -47,17 +47,9 @@ In case you add keys to the changelog, please follow these rules: #### Author credits -You will be given credit in the [`AUTHORS`](https://github.com/JabRef/jabref/blob/master/AUTHORS) file in the root of the repository and the 'About' pages inside the main application. -We will periodically update the contributors list inside `AUTHORS`. -This is done by an automatic shell script `scripts/generate-authors.sh`. - -If you want to add yourself directly with your pull request please run this script. -Please make sure there are no duplicates or alternate spellings of your name listed. -If you need to merge different Git usernames or email addresses you can do so by editing `.mailmap`. -More information on this can be found via `man git-shortlog`. - Please, **do not add yourself at JavaDoc's `@authors`**. -The contribution information is tracked via the version control system. +The contribution information is tracked via the version control system and shown at . +We also link to the contributors page in our about dialog. Your contribution is considered being made under [MIT license](https://tldrlegal.com/license/mit-license). diff --git a/scripts/generate-authors.sh b/scripts/generate-authors.sh deleted file mode 100755 index e83d6a734e9..00000000000 --- a/scripts/generate-authors.sh +++ /dev/null @@ -1,62 +0,0 @@ -#!/bin/bash -set -e - -cd "$(dirname "$(readlink -f "$BASH_SOURCE")")/.." - -# see also ".mailmap" for how email addresses and names are deduplicated -{ - cat <<-'EOF' - # This file lists all individuals having contributed content to the repository. - # For how it is generated, see `scripts/generate-authors.sh`. - EOF - - # old manual entries - read -d '' authors <<-"EOF" || true - Michel Baylac - Cyrille d'Haese - Ellen Reitmayr - Michael Beckmann - Oliver Beckmann - Fedor Bezrukov - Fabian Bieker - Aaron Chen - Fabrice Dessaint - Nathan Dunn - Alexis Gallagher - David Gleich - Behrouz Javanmardi - Bernd Kalbfuss - Martin Kähmer - Ervin Kolenovic - Krzysztof A. Kościuszkiewicz - Christian Kopf - Jeffrey Kuhn - Uwe Kuehn - Felix Langner - Stephan Lau - Alex Montgomery - Saverio Mori - Ambrogio Oliva - Stephan Rave - John Relph - Hannes Restel - Moritz Ringler - Rudolf Seemann - Toralf Senger - Manuel Siebeneicher - Mike Smoot - Ulrich Stärk - Martin Stolle - David Weitzman - John Zedlewski - Samin Muhammad Ridwanul Karim - Stefan Robert - Bernhard Tempel - EOF - - # authors %aN = author name - - # co-authors - coauthors=$(git log -i --grep=co-authored-by | grep -i "co-authored-by" | sed "s/.*co-authored-by: \(.*\)/\1/I" | grep -v "luis-valdez" | sed "s/ <.*//") - echo -e "$authors\n$(git log --format='%aN')\n$coauthors" | grep -v "\[bot\]" | grep -v "JabRef" | grep -v "Siedlerchr" | grep -v "^Christoph$" | grep -v "^Mootez$" | grep -v "oscargus" | grep -v "dependabot" | grep -v "github actions" | grep -v "igorsteinmacher" | grep -v "halirutan" | grep -v "matthiasgeiger" | grep -v "Gitter Badger" | grep -v "gdstewart" | grep -v "m-mauersberger" | grep -v "chenyuheng" | LC_ALL=C.UTF-8 sort --unique --ignore-case -} > AUTHORS diff --git a/src/main/java/org/jabref/gui/help/AboutDialog.css b/src/main/java/org/jabref/gui/help/AboutDialog.css index 9793ab8df1e..04dd4e9d0e7 100644 --- a/src/main/java/org/jabref/gui/help/AboutDialog.css +++ b/src/main/java/org/jabref/gui/help/AboutDialog.css @@ -37,6 +37,10 @@ -fx-padding: 5px; } +.contrib-section { + -fx-padding: 5 5 10 5; +} + .logo-pane { fx-fill: transparent; } diff --git a/src/main/java/org/jabref/gui/help/AboutDialog.fxml b/src/main/java/org/jabref/gui/help/AboutDialog.fxml index 04bd74b6c6d..8dea325a531 100644 --- a/src/main/java/org/jabref/gui/help/AboutDialog.fxml +++ b/src/main/java/org/jabref/gui/help/AboutDialog.fxml @@ -4,7 +4,6 @@ - @@ -15,7 +14,7 @@ - + @@ -83,13 +82,11 @@ -