Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

whatsnew - using the author github id #3849

Merged
merged 2 commits into from
Sep 15, 2020
Merged

whatsnew - using the author github id #3849

merged 2 commits into from
Sep 15, 2020

Conversation

bjlittle
Copy link
Member

🚀 Pull Request

Description

This PR makes a simple change to the latest whatsnew to opt to using and citing pull-request authors using their GitHub ID.

On reflection, this might be a better long term approach as:

  • It's one less step for the person writing the whatsnew entry, as they no longer have to "look up" the authors profile to determine whether their GitHub name matches their GitHub ID
  • The GitHub ID is how people are commonly referred to within the GitHub community, so it's easy to cross-reference the GitHub ID with their work on GitHub or locally within a repo, but this is not true for the GitHub name
  • We are less likely to make an error when citing the GitHub ID

A built version of this pull-request is available on readthedocs, to easily view the rendered changes:

Consult Iris pull request check list

@bjlittle bjlittle added this to the v3.0.0 milestone Sep 15, 2020
@bjlittle
Copy link
Member Author

ping @SciTools/iris-devs

@rcomer
Copy link
Member

rcomer commented Sep 15, 2020

It also means they can all be consistent, as everyone has a GitHub ID but not everyone has a GitHub name 👍 .

@trexfeathers
Copy link
Contributor

Thanks @bjlittle, LGTM

@trexfeathers trexfeathers merged commit cb6290f into SciTools:master Sep 15, 2020
@bjlittle
Copy link
Member Author

@trexfeathers Awesome, thanks!

@bjlittle bjlittle deleted the latest-names branch September 15, 2020 14:42
tkknight added a commit to tkknight/iris that referenced this pull request Sep 15, 2020
@tkknight
Merge branch 'master' into developer_guide_overhaul
7f1e58f 
* master:
  whatsnew - using the author github id (SciTools#3849)
  Bring SciTools#3804 whatsnew in line with format changes from SciTools#3838. (SciTools#3847)
  "What's New" credit and referencing (SciTools#3838)
  Allow passing None for all coord-system optional args. (SciTools#3804)
  var_name in AuxCoord created by trajectory.interpolate() (SciTools#3718)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@trexfeathers trexfeathers trexfeathers approved these changes

Assignees
No one assigned
Labels
Type: Documentation Type: Enhancement
Projects
None yet
Milestone
v3.0.0
Development

Successfully merging this pull request may close these issues.
3 participants
@bjlittle @rcomer @trexfeathers