Skip to content

Add validation of "AUTHORS" file#6722

Merged
koppor merged 4 commits into
masterfrom
complain-if-not-contained-in-authors
Aug 1, 2020
Merged

Add validation of "AUTHORS" file#6722
koppor merged 4 commits into
masterfrom
complain-if-not-contained-in-authors

Conversation

@koppor

@koppor koppor commented Jul 28, 2020

Copy link
Copy Markdown
Member

Just before a release, I have to check the names of the contributors to be able to add them to AUHTORS. This is a good habit, where I received positive feedback for. We outline that in our contribution guide at https://github.com/JabRef/jabref/blob/master/CONTRIBUTING.md#author-credits, but it seems no one reads that far.

The issue is that 80% of the names are wrong. Be it casing errors, misspellings, multiple email adresses with slightly dfferent name, or no name at all.

To redeuce the load on my side, I created a check which comments on the PR if some new names will be added.

Example:

grafik

The check renders as follows if no new AUTHOR was found:

grafik

  • 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.

@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, just a bit of nit-picking.

Comment thread .github/workflows/tests.yml Outdated
Comment thread .github/workflows/tests.yml Outdated
Comment thread .github/workflows/tests.yml Outdated
echo "No authors added"
exit 0
fi
message="When merged, this pull request will introduce additions in the [AUTHORS file](https://github.com/JabRef/jabref/blob/master/CONTRIBUTING.md#author-credits). In case you want to appear differently, please [adjust your name in your git configuration](https://docs.github.com/en/github/using-git/setting-your-username-in-git).%0A%0A\`\`\`%0A${added//$'\n'/'%0A'}%0A\`\`\`%0A"

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.

And then force push? or how is the change to the git config reflected in the PR?

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Yes. Could be difficult for the newcomers. Nevertheless, I would urge them to get their git configured properly.

I added some text with links here.

@koppor koppor merged commit 125a0c1 into JabRef:master Aug 1, 2020
@koppor koppor deleted the complain-if-not-contained-in-authors branch August 1, 2020 16:16
@koppor koppor restored the complain-if-not-contained-in-authors branch August 1, 2020 16:16
@koppor koppor deleted the complain-if-not-contained-in-authors branch August 1, 2020 16:16
Siedlerchr added a commit that referenced this pull request Aug 9, 2020
* upstream/master: (47 commits)
  Fix copy pasting and delete via menu or key (#6740)
  Add instructions how to work with fetchers  (#6731)
  Autoinstall extension in chrome (#6442)
  Delete link after download (#6723)
  New translations JabRef_en.properties (Portuguese, Brazilian) (#6728)
  Bump pascalgn/automerge-action from v0.8.5 to v0.9.0 (#6736)
  Bump byte-buddy-parent from 1.10.13 to 1.10.14 (#6733)
  Bump mockito-core from 3.4.4 to 3.4.6 (#6734)
  Bump unirest-java from 3.8.06 to 3.9.00 (#6735)
  Bump org.beryx.jlink from 2.21.1 to 2.21.2 (#6732)
  Add testing interface, including a set of capabilities to tests for (#6687)
  Fix pasting on mac and linux (#6419)
  Add validation of "AUTHORS" file (#6722)
  Squashed 'src/main/resources/csl-styles/' changes from cacc4ee..827b986
  New Crowdin updates (#6721)
  Add missing AUTHORs
  Fix for issue 6639 (#6719)
  Fix more links
  Fix link
  New Crowdin updates (#6718)
  ...
@koppor koppor mentioned this pull request Sep 24, 2020
5 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants