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

"What's New" credit and referencing #3838

Merged
merged 17 commits into from
Sep 15, 2020
Merged

"What's New" credit and referencing #3838

merged 17 commits into from
Sep 15, 2020

Conversation

trexfeathers
Copy link
Contributor

Adds two new aspects to Iris "What's New" entries to improve Iris' efficacy as an open source project.

  • Pull Request references
    Open source projects need to be both dynamic and transparent, so it's important that anyone interested can get as much detail as they need on changes in the project.
  • Crediting developers
    Open source communities rely on their developer base, some of whom might be volunteering their time. Public recognition rewards contributing developers and demonstrates the quality of the community, hopefully encouraging further and wider collaboration.

Mimicking the Cartopy format - developer credit first - meant adapting the 'voice' of many of the existing "What's New" entries to get them to state the implemented change before any further context. If anyone below feels I have minced their words, or if they are unhappy being publicly credited, feel free to speak up!

@trexfeathers trexfeathers added this to the v3.0.0 milestone Sep 10, 2020
@trexfeathers
Copy link
Contributor Author

Closes #3818

@trexfeathers
Copy link
Contributor Author

@bouweandela as one of our newest core devs do you fancy reviewing and merging your first Iris PR?

This was referenced Sep 11, 2020
Closed
Merged
@trexfeathers
Copy link
Contributor Author

trexfeathers commented Sep 11, 2020 •
edited
Loading

Ported over the contents of #3843 - felt like I was asking for Git trouble otherwise!

Closes #3837

Adds:

  • Consistent "What's New" ordering and headings between docs, template and latest.rst
    With Internal now at the bottom
  • Updated docs on what is expected regarding "What's New" entries
  • Updated docs pull request checklist to bring in line with current verbally agreed practices
  • Added pull request template referencing the docs pull request checklist

stephenworsley
stephenworsley requested changes Sep 14, 2020
View reviewed changes
Copy link
Contributor

@stephenworsley stephenworsley left a comment

Choose a reason for hiding this comment

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

Mostly just a couple typos to fix. Otherwise this is looking good. Good work!

@trexfeathers
Copy link
Contributor Author

Will need a follow up PR to correct the "What's New" from #3804

@stephenworsley stephenworsley merged commit 767c66c into SciTools:master Sep 15, 2020
@pp-mo
Copy link
Member

pp-mo commented Sep 15, 2020

I see that you are mostly using full real names, but not for everyone, e.g here and here.
I assume you have based this on the public user account details, hence e.g. @lbdreyer is not identified.
I guess that is ok + means you don't have to ask everyone what they are happy with.

However. I think it might look better, and be safer in terms of what contributors are really comfortable with, to just use user ids.
Certainly, I always stick to userids in discussions, where I don't want to give any appearance of relying on offline relations.

@trexfeathers
Copy link
Contributor Author

I see that you are mostly using full real names, but not for everyone, e.g here and here.
I assume you have based this on the public user account details, hence e.g. @lbdreyer is not identified.
I guess that is ok + means you don't have to ask everyone what they are happy with.

#3838 (comment)

@trexfeathers trexfeathers mentioned this pull request Sep 15, 2020
Closed
trexfeathers added a commit to trexfeathers/iris that referenced this pull request Sep 15, 2020
@trexfeathers
Bring SciTools#3804 whatsnew in line with format changes from SciTool…
ad817ff 
…s#3838.
@trexfeathers trexfeathers mentioned this pull request Sep 15, 2020
Merged
bjlittle pushed a commit that referenced this pull request Sep 15, 2020
@trexfeathers
Bring #3804 whatsnew in line with format changes from #3838. (#3847)
6afb6db
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)
@trexfeathers trexfeathers deleted the whatsnew_referencing branch February 23, 2021 11:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@bjlittle bjlittle bjlittle left review comments

@tkknight tkknight tkknight left review comments

@rcomer rcomer rcomer left review comments

@stephenworsley stephenworsley stephenworsley approved these changes

@bouweandela bouweandela Awaiting requested review from bouweandela

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.
7 participants
@trexfeathers @pp-mo @bjlittle @tkknight @bouweandela @rcomer @stephenworsley