Skip to content

Link to GitHub contributors in about dialog#7319

Merged
koppor merged 8 commits into
masterfrom
authors
Jan 11, 2021
Merged

Link to GitHub contributors in about dialog#7319
koppor merged 8 commits into
masterfrom
authors

Conversation

@stefan-kolb

@stefan-kolb stefan-kolb commented Jan 8, 2021 •
edited
Loading

Copy link
Copy Markdown
Member

Remove AUTHORS file

Reason

  • AUTHORS file is hard to maintain
  • Github/Git is single source of truth
  • some authors did not want to be listed by name -> Github profile is maintained by them or NOT if they do not want to
  • AUTHORS list also includes 12345 and duplicate names that look odd (and that was the reason why we had mailmap and such to avoid it)

Solutions

Decision

  • Change info dialog to link to contributors
  • global RM search for AUTHORS (.gitattributes)
  • RM .mailmap
  • disable fullscreen and resize

image

  • Change in CHANGELOG.md described (if applicable)
  • Tests created for changes (if applicable)
  • Manually tested changed features in running JabRef (always required)
  • Screenshots added in PR description (for UI changes)
  • Checked documentation: Is the information available and up to date? If not created an issue at https://github.com/JabRef/user-documentation/issues or, even better, submitted a pull request to the documentation repository.

@stefan-kolb
Link to Github contributors in about dialog
ac189c5 
Remove AUTHORS file workflow
@koppor koppor changed the title Link to Github contributors in about dialog Link to GitHub contributors in about dialog Jan 8, 2021
@koppor

koppor commented Jan 8, 2021 •
edited
Loading

Copy link
Copy Markdown
Member

Alternatives: Maintain "All Contributors" (contributing ideas, discussions, feedback): https://github.com/all-contributors/all-contributors. This is much effort and causes huge mental workload. We want to spend our energy on fixing issues and providing issue feedback.

We accept that contributors contributing something before the GitHub area (on SourceForge) are not listed explicitly after merging this PR. They are still listed in v5.1 and earlier. They can also be found at the link.

jabref/scripts/generate-authors.sh

Line 54 in 3ebba86

Bernhard Tempel

@koppor

koppor commented Jan 8, 2021

Copy link
Copy Markdown
Member

While working on it, we also renamed "Developers" to "Maintainers", since @JabRef/developers are more the overall maintainers. IMHO, this is more welcoming to contributors, because they are also developers, but not maintainers of JabRef. We as maintainers are also developers.

@stefan-kolb @koppor
Add contributors to about dialog
7ff754c 
Co-authored-by: Oliver Kopp <kopp.dev@gmail.com>
@Siedlerchr

Siedlerchr commented Jan 8, 2021

Copy link
Copy Markdown
Member

What about core developers and contributer?

@tobiasdiez

tobiasdiez commented Jan 8, 2021 •
edited by koppor
Loading

Copy link
Copy Markdown
Member

+1 for removing the authors and also for this

use something like https://github.com/mgechev/github-contributors-list to generate file

We could put the file at jabref.org/contributors and link it in the about dialog (and from the main website).

@koppor

koppor commented Jan 9, 2021

Copy link
Copy Markdown
Member

use something like mgechev/github-contributors-list to generate file

We could put the file at jabref.org/contributors and link it in the about dialog (and from the main website).

Another tool is "true-contributors", which also lists issue reporters, etc. --> https://github.com/100Automations/true-github-contributors#readme. Not too bad, too, IMHO.

@stefan-kolb stefan-kolb requested review from koppor and tobiasdiez and removed request for koppor January 9, 2021 21:40
@koppor

koppor commented Jan 9, 2021

Copy link
Copy Markdown
Member

Using jabref.org/contributors instead of https://github.com/JabRef/jabref/graphs/contributors will be part of a follow-up PR as I don't currently have the time to implement that.

@koppor koppor marked this pull request as ready for review January 9, 2021 21:45
@koppor koppor removed their request for review January 9, 2021 21:45
@koppor koppor removed their request for review January 9, 2021 21:47
Siedlerchr
Siedlerchr previously approved these changes Jan 9, 2021
View reviewed changes
@koppor koppor added the status: ready-for-review Pull Requests that are ready to be reviewed by the maintainers label Jan 10, 2021
tobiasdiez
tobiasdiez requested changes Jan 10, 2021
View reviewed changes

@tobiasdiez tobiasdiez left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, one small comment, then it can be merged.

Comment thread src/main/java/org/jabref/gui/help/AboutDialogViewModel.java Outdated
@tobiasdiez tobiasdiez added the status: changes-required Pull requests that are not yet complete label Jan 10, 2021
calixtus
calixtus previously approved these changes Jan 10, 2021
View reviewed changes

@calixtus calixtus left a comment •
edited
Loading

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't really have a strong opinion on these changes.
As long as somehow the contributors who like to be known (and also those of the sourceforge-era) get credit for their work somehow, I'm fine with the changes.

@stefan-kolb stefan-kolb dismissed stale reviews from calixtus and Siedlerchr via 85a71a1 January 10, 2021 22:20
@koppor

koppor commented Jan 11, 2021

Copy link
Copy Markdown
Member

As long as somehow the contributors who like to be known (and also those of the sourceforge-era) get credit for their work somehow, I'm fine with the changes.

I did not receive any explicit request. Thus, I would continue here and handle "exceptions" as soon as someone raises his voice.

@koppor koppor merged commit 519bc3a into master Jan 11, 2021
@koppor koppor deleted the authors branch January 11, 2021 06:10
@koppor koppor removed status: changes-required Pull requests that are not yet complete status: ready-for-review Pull Requests that are ready to be reviewed by the maintainers labels Jan 11, 2021
Siedlerchr added a commit that referenced this pull request Jan 13, 2021
@Siedlerchr
Merge remote-tracking branch 'upstream/master' into importerbackgroun…
0426fd2 
…dtask

* upstream/master:
  Update guidelines-for-setting-up-a-local-workspace.md (#7339)
  Updates to colored group indicator for cited entries (#7173)
  Add some special fields as default columns (#7286)
  Add a more descriptive path when Directory cannot be found (#7232)
  Bump antlr4 from 4.9 to 4.9.1 (#7327)
  Bump unirest-java from 3.11.09 to 3.11.10 (#7329)
  Bump mockito-core from 3.6.28 to 3.7.0 (#7328)
  Bump antlr4-runtime from 4.9 to 4.9.1 (#7330)
  Bump gittools/actions from v0.9.7 to v0.9.8 (#7331)
  Update to gradle 6.8 (#7324)
  Link to GitHub contributors in about dialog (#7319)
  Fix snapcraft upload (#7263)
@koppor koppor mentioned this pull request Feb 16, 2021
Merged
5 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@koppor koppor koppor approved these changes

@Siedlerchr Siedlerchr Siedlerchr left review comments

@calixtus calixtus calixtus left review comments

@tobiasdiez tobiasdiez Awaiting requested review from tobiasdiez

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@stefan-kolb @koppor @Siedlerchr @tobiasdiez @calixtus