Revise authorship policy for AI-assisted contributions #4871
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -21,8 +21,9 @@ The following are the ways in which individuals who have contributed will be rec | |
| ## The `AUTHORS.md` file | ||
|
|
||
| The `AUTHORS.md` file lists PyGMT Developers. Anyone who has contributed a pull request | ||
| (without AI assistance) to the project is welcome to add themselves to the file. This | ||
| file lives in the repository and is packaged with distributions. This is an optional | ||
| process. | ||
|
|
||
| ## The PyGMT Team | ||
|
|
||
|
|
@@ -35,13 +36,13 @@ many ways in the project's history. | |
| ## Changelog for each release | ||
|
|
||
| Every time we make a release, everyone who has made a contribution (commits or PR | ||
| reviews) to the repository (with or without AI-assistance), since the previous release | ||
|
Member
Author
There was a problem hiding this comment. I think changelog entries should still contain contributions that have been AI-assisted. Hopefully not controversial?
Contributor
There was a problem hiding this comment. Agreed; I think AI-assisted changes are still valid changes. |
||
| will be mentioned in the changelog. If their full name is available on GitHub, we will | ||
| use it. Otherwise, we will use their GitHub handle. This is a way of saying "Thank you". | ||
|
|
||
| ## Authorship on Zenodo archives of releases | ||
|
|
||
| Anyone who has contributed to the repository (i.e., appears on `git log`) may be | ||
| invited to be an author on the Zenodo archive of new releases. | ||
|
|
||
| To be included as an author, you *must* add the following to the `AUTHORS.md` file of | ||
|
|
@@ -51,9 +52,9 @@ the repository: | |
| 2. [ORCID](https://orcid.org) (optional) | ||
| 3. Affiliation (if omitted, we will use "Unaffiliated") | ||
|
|
||
| The order of authors will be defined by the number of non-AI-assisted contributions | ||
| (including commits and PR reviews) to the repository | ||
| (`git shortlog -sne --group=author --group=trailer:co-authored-by --invert-grep --grep=Assisted-by`). | ||
|
Member
Author
There was a problem hiding this comment. Should we exclude commits that are AI-
Contributor
There was a problem hiding this comment. Similarly to my other comment about maintainers' discretion, I think there should also be discretion in the sorting of the author list. I think lines of code is a good starting point and gives a rough idea of contributions, but I do think that it can incentivize longer contributions (e.g. tutorials, long documentation) that is useful, but isn't more useful than PRs with fewer lines of code. |
||
| The order can also be changed on a case-by-case basis. The most common reasons for | ||
| case-by-case changes are contributions to the PyGMT project that do not relate to | ||
| commit numbers, including developing PyGMT lessons such as the | ||
|
|
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Based on #4839 (comment). But happy to revise this to set a threshold or something.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is a bit of a vague suggestion (sorry), but I do think setting the requirement for inclusion can be made a little less defined and state that the maintainers will add additional authors to AUTHORS.md in a PR. I think that having a hard limit of AI-assisted vs. non-AI-assisted can either incentivize lying about how AI was used, or can punish contributors for using AI in any way. While I don't think a contribution entirely from AI should merit inclusion as an author, I don't want to punish a contributor who meaningfully contributes but may use AI to either proofread or clean up their work. I realize that is hard to define, but I also think that is where maintainers' judgement can come into play when a contributor has been actively participating and a maintainer can submit a PR adding them to AUTHORS.md (and tag the contributor to make sure they want to be added).
Not that I expect pygmt to become insanely popular (we can dream!) but AUTHORS.md currently has 18 authors listed. I don't wish to set the bar high or come across as unwelcoming to new contributors, but I do think the list could be in the 30-40 range if the requirement is a single non-AI contributions, which seems longer than it should be.