Update the AUTHORSHIP and Maintainers' Guides to reflect co-author contributions#3904
Merged
Update the AUTHORSHIP and Maintainers' Guides to reflect co-author contributions#3904
Conversation
seisman
commented
Apr 10, 2025
| of any author who hasn't made any commits will be decided by all authors. The order can | ||
| also be changed on a case-by-case basis. | ||
| major release that has an associated paper | ||
| (`git shortlog vX.Y.Z..HEAD -sne --group=author --group=trailer:co-authored-by`). |
Member
Author
There was a problem hiding this comment.
Please note that we inconsistently used git shortlog vX.0.0...HEAD -sne and git shortlog HEAD...v0.4.0 -sne in the old versions.
In the new version, I've changed them to git shortlog vX.Y.Z..HEAD (tag before HEAD vs HEAD before tag, .. vs ...). Their differences are summaried below (from ChatGPT):
| Command | Meaning | Use Case |
|---|---|---|
git shortlog v0.14.0..HEAD |
Commits in HEAD but not in v0.14.0 |
✅ Changes since the tag |
git shortlog HEAD..v0.14.0 |
Commits in v0.14.0 but not in HEAD |
🔄 Unusual — usually empty if HEAD is ahead |
git shortlog v0.14.0...HEAD |
Commits in v0.14.0 or HEAD, but not both (symmetric difference) |
🔍 Compare diverged histories |
git shortlog HEAD...v0.14.0 |
Same as above — order doesn’t matter | 🔍 Same as above |
The three-dot version doens't work well for patch releases like v0.14.1/v0.14.2.
Member
There was a problem hiding this comment.
Uhh, did not realize so far, that there are two and three dot versions 😅.
Co-authored-by: Yvonne Fröhlich <94163266+yvonnefroehlich@users.noreply.github.com>
Member
Author
|
With PR #3905 merged, the output is: |
michaelgrund
approved these changes
Apr 14, 2025
weiji14
reviewed
Apr 15, 2025
Co-authored-by: Wei Ji <23487320+weiji14@users.noreply.github.com>
Member
Author
It's already done (https://github.com/GenericMappingTools/pygmt/pull/3904/files) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
See issue #3746 for context. Closes #3746.
This PR updates the AUTHORSHIP file and maintainers' guides to clarify that we consider co-authorship (e.g., PR reviews) when counting contributions. This is in line with what we're saying in AUTHORSHIP:
To consider co-authorship (PR reviews), we need to use the following command to count the contributions:
For comparison, the first 10 lines of
git shortlog -sne's output are:For
git shortlog -sne --group=author --group=trailer:co-authored-by, the output is:These numbers are still different from the numbers on the GitHub contributors page (https://github.com/GenericMappingTools/pygmt/graphs/contributors), but see #3905.