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

Core team member guide #7999

Merged
merged 28 commits into from
Jul 21, 2023
Merged

Core team member guide #7999

merged 28 commits into from
Jul 21, 2023

Conversation

TomNicholas
Copy link
Member

@TomNicholas TomNicholas commented Jul 18, 2023

Adds a guide for core developers of xarray. Mostly adapted from napari's core dev guide, but with some extra sections and ideas from the pandas maintainance guide.

@pydata/xarray please give your feedback on this! If you prefer to give feedback in a non-public channel for whatever reason then please use the private core team email.

  • Closes #xxxx
  • Tests added
  • User visible changes (including notable bug fixes) are documented in whats-new.rst
  • New functions/methods are listed in api.rst

Copy link
Collaborator

@headtr1ck headtr1ck left a comment

Choose a reason for hiding this comment

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

Nice addition.
Maybe we can add a paragraph in the beginning that makes it clear that you don't have to work more with this role, to not scare off people :)

CORE_DEV_GUIDE.md Outdated Show resolved Hide resolved
@shoyer
Copy link
Member

shoyer commented Jul 18, 2023

Generally, this looks great, but can we adjust the language/title to emphasize "Core team member" rather than "Core developer" to be more inclusive?

TomNicholas and others added 3 commits July 18, 2023 12:00
@TomNicholas TomNicholas changed the title Core developer guide Core team member guide Jul 18, 2023
CORE_DEV_GUIDE.md Outdated Show resolved Hide resolved
CORE_DEV_GUIDE.md Outdated Show resolved Hide resolved
CORE_DEV_GUIDE.md Outdated Show resolved Hide resolved
@TomNicholas
Copy link
Member Author

TomNicholas commented Jul 18, 2023

Okay I've addressed all the comments so far, reorganised, and included sections on issue triage from the pandas maintainers guide.

Copy link
Contributor

@dcherian dcherian left a comment

Choose a reason for hiding this comment

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

This is great, Tom. I love it!

Just some minor suggestions. It would be nice to render this on the website. We might have to add myst-nb etc. to the sphinx config (#7924). Could easily be done in a follow up PR though

CORE_TEAM_GUIDE.md Outdated Show resolved Hide resolved
CORE_TEAM_GUIDE.md Outdated Show resolved Hide resolved
CORE_TEAM_GUIDE.md Show resolved Hide resolved
CORE_TEAM_GUIDE.md Outdated Show resolved Hide resolved
CORE_TEAM_GUIDE.md Outdated Show resolved Hide resolved
CORE_TEAM_GUIDE.md Outdated Show resolved Hide resolved
CORE_TEAM_GUIDE.md Outdated Show resolved Hide resolved
CORE_TEAM_GUIDE.md Show resolved Hide resolved
CORE_TEAM_GUIDE.md Outdated Show resolved Hide resolved
CORE_TEAM_GUIDE.md Outdated Show resolved Hide resolved
Co-authored-by: Deepak Cherian <dcherian@users.noreply.github.com>
@TomNicholas
Copy link
Member Author

This is great, Tom. I love it!

😁

It would be nice to render this on the website. We might have to add myst-nb etc. to the sphinx config (#7924). Could easily be done in a follow up PR though.

I agree, and I started by rewriting it as RST, but I got sick of reformatting the markdown copied from napari's docs so I decided to just leave that to a later PR. I think it's useful to concentrate on discussing the actual content of the guide in this PR too.

@TomNicholas TomNicholas added the plan to merge Final call for comments label Jul 19, 2023
Copy link
Member

@jhamman jhamman left a comment

Choose a reason for hiding this comment

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

Thanks for writing this @TomNicholas! I left one comment but have an additional question. Should we put this in the documentation. There is some overlap here with the contribution guide. I wonder if this should be a page next to the broader guide.

CORE_TEAM_GUIDE.md Outdated Show resolved Hide resolved
@TomNicholas
Copy link
Member Author

TomNicholas commented Jul 20, 2023 via email

@TomNicholas TomNicholas enabled auto-merge (squash) July 21, 2023 13:22
@TomNicholas TomNicholas merged commit efa2863 into pydata:main Jul 21, 2023
@TomNicholas TomNicholas deleted the core_dev_guide2 branch July 21, 2023 14:51
dcherian added a commit to dcherian/xarray that referenced this pull request Jul 24, 2023
…lazy-array

* upstream/main: (153 commits)
  Add HDF5 Section to read/write docs page (pydata#8012)
  [pre-commit.ci] pre-commit autoupdate (pydata#8014)
  Update interpolate_na in dataset.py (pydata#7974)
  improved docstring of to_netcdf (issue pydata#7127) (pydata#7947)
  Expose "Coordinates" as part of Xarray's public API (pydata#7368)
  Core team member guide (pydata#7999)
  join together duplicate entries in the text `repr` (pydata#7225)
  Update copyright year in README (pydata#8007)
  Allow opening datasets with nD dimenson coordinate variables. (pydata#7989)
  Move whats-new entry
  [pre-commit.ci] pre-commit autoupdate (pydata#7997)
  Add documentation on custom indexes (pydata#6975)
  Use variable name in all exceptions raised in `as_variable` (pydata#7995)
  Bump pypa/gh-action-pypi-publish from 1.8.7 to 1.8.8 (pydata#7994)
  New whatsnew section
  Remove future release notes before this release
  Update whats-new.rst for new release (pydata#7993)
  Remove hue_style from plot1d docstring (pydata#7925)
  Add new what's new section (pydata#7986)
  Release summary for v2023.07.0 (pydata#7979)
  ...
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
community plan to merge Final call for comments
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants