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.

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

Update contribution guidelines #2031

Merged
merged 20 commits into from Mar 15, 2021
Merged

Update contribution guidelines #2031

merged 20 commits into from Mar 15, 2021

Conversation

bouweandela
Copy link
Member

@bouweandela bouweandela commented Feb 16, 2021

The goal of this pull request is to align and clarify the documentation on contributing and the pull request checklist from the template.

TODO: replace https://esmvaltool--2031.org.readthedocs.build/en/2031/ with https://docs.esmvaltool.org/en/latest/ everywhere in the template before merging


Before you get started

Checklist

It is the responsibility of the author to make sure the pull request is ready to review. The icons indicate whether the item will be subject to the 🛠 Technical or 🧪 Scientific review.


To help with the number pull requests:

@bouweandela bouweandela changed the title Add checklist Update contribution guidelines Feb 16, 2021
@nielsdrost
Copy link
Member

Nice work @bouweandela!

Some comments on the table of content and section names:

  • The introduction section perhaps needs a new name
  • Release schedule could perhaps be after the pull request section, or at the end
  • Moving work... section should be after the GitHub workflow (which explains there is a private repo)
  • The 'Porting a namelist (recipe) or diagnostic from version 1 to version 2' section is perhaps a bit long for a title

@bouweandela bouweandela marked this pull request as ready for review March 12, 2021 21:32
Copy link
Member

@nielsdrost nielsdrost left a comment

Choose a reason for hiding this comment

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

Awesome work @bouweandela! I read all the new documentation and checked as many links as I could, I think this is ready to go!

@bouweandela bouweandela merged commit aaaa4b5 into master Mar 15, 2021
@bouweandela bouweandela deleted the pull-request-guidelines branch March 15, 2021 19:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants