Core team member guide #7999

TomNicholas · 2023-07-18T15:26:01Z

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~~

headtr1ck

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

shoyer · 2023-07-18T15:51:36Z

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

Co-authored-by: Michael Niklas <mick.niklas@gmail.com>

CORE_DEV_GUIDE.md

CORE_TEAM_GUIDE.md

TomNicholas · 2023-07-18T17:35:06Z

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

dcherian

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

Co-authored-by: Deepak Cherian <dcherian@users.noreply.github.com>

TomNicholas · 2023-07-18T20:16:26Z

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.

jhamman

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

TomNicholas · 2023-07-20T00:08:22Z

Thanks @jhamman. Yes there is definitely some overlap, and this should go in the main docs. However I thought it was easier just to leave that reorganization for a follow-up PR, and concentrate on the content in this PR, as Deepak and I discussed above.

…

On Wed, Jul 19, 2023, 8:04 PM Joe Hamman ***@***.***> wrote: ***@***.**** commented on this pull request. Thanks for writing this @TomNicholas <https://github.com/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 <https://docs.xarray.dev/en/stable/contributing.html>. I wonder if this should be a page next to the broader guide. ------------------------------ In CORE_TEAM_GUIDE.md <#7999 (comment)>: > + We prefer that usage questions are asked on StackOverflow with the pandas tag. https://stackoverflow.com/questions/tagged/pandas + + If it’s easy to answer, feel free to link to the relevant documentation section, let them know that in the future this kind of question should be on StackOverflow, and close the issue. ⬇️ Suggested change - We prefer that usage questions are asked on StackOverflow with the pandas tag. https://stackoverflow.com/questions/tagged/pandas - - If it’s easy to answer, feel free to link to the relevant documentation section, let them know that in the future this kind of question should be on StackOverflow, and close the issue. + We prefer that usage questions are asked on StackOverflow with the [`python-xarray` tag](https://stackoverflow.com/questions/tagged/python-xarray +) or as a [GitHub discussion topic](https://github.com/pydata/xarray/discussions). + + If it’s easy to answer, feel free to link to the relevant documentation section, let them know that in the future this kind of question should be on StackOverflow, and close the issue. — Reply to this email directly, view it on GitHub <#7999 (review)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AISNPI2QKNKSBMOO5SDMZATXRBYXRANCNFSM6AAAAAA2OSK24A> . You are receiving this because you were mentioned.Message ID: ***@***.***>

Co-authored-by: Joe Hamman <jhamman1@gmail.com>

for more information, see https://pre-commit.ci

… into core_dev_guide2

CORE_TEAM_GUIDE.md

…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) ...

TomNicholas added 6 commits July 18, 2023 10:02

copy napari core dev guide

8e21193

replace all instance of napari with xarray

cd7f417

rewrite some napari-specific sentences

ab83818

update links in the resources

818f958

list tasks

8689592

fixes

6ec673d

TomNicholas added the community label Jul 18, 2023

headtr1ck approved these changes Jul 18, 2023

View reviewed changes

CORE_DEV_GUIDE.md Outdated Show resolved Hide resolved

TomNicholas and others added 3 commits July 18, 2023 12:00

mention the plan to merge label

8608956

Co-authored-by: Michael Niklas <mick.niklas@gmail.com>

core dev -> core team member

78b9e1a

choose your own title

7eb0da6

TomNicholas changed the title ~~Core developer guide~~ Core team member guide Jul 18, 2023

shoyer reviewed Jul 18, 2023

View reviewed changes

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 added 3 commits July 18, 2023 12:34

rearrange sections to put tasks before code contributions

3d6a25c

remove dramatic nuclear launch keys analogy

bd71ff6

link to bi-weekly developers meeting

6a15fee

TomNicholas commented Jul 18, 2023

View reviewed changes

CORE_TEAM_GUIDE.md Show resolved Hide resolved

TomNicholas added 8 commits July 18, 2023 12:56

add more types of tasks

a4291f4

mention presenting tutorials

b70c061

mention representing xarray in user communities

cdd1de4

yet more tasks

40f0b2e

note that you don't have to do everything

000e505

paragraph at top making it clear no extra work is required!

c7b8f23

whatsnew

9acb87b

add section on issue triage

5b5d52d

dcherian approved these changes Jul 18, 2023

View reviewed changes

keewis mentioned this pull request Jul 18, 2023

join together duplicate entries in the text repr #7225

Merged

3 tasks

Apply suggestions from Deepak's code review

129cf01

Co-authored-by: Deepak Cherian <dcherian@users.noreply.github.com>

various fixes

06384f1

TomNicholas added the plan to merge Final call for comments label Jul 19, 2023

jhamman reviewed Jul 20, 2023

View reviewed changes

CORE_TEAM_GUIDE.md Outdated Show resolved Hide resolved

TomNicholas and others added 4 commits July 19, 2023 19:08

Update CORE_TEAM_GUIDE.md

3f8c522

Co-authored-by: Joe Hamman <jhamman1@gmail.com>

[pre-commit.ci] auto fixes from pre-commit.com hooks

ffe09c1

for more information, see https://pre-commit.ci

Merge branch 'main' into core_dev_guide2

fc6e7ef

Merge branch 'core_dev_guide2' of https://github.com/TomNicholas/xarray…

68e12b1

… into core_dev_guide2

TomNicholas commented Jul 21, 2023

View reviewed changes

CORE_TEAM_GUIDE.md Show resolved Hide resolved

TomNicholas added 2 commits July 21, 2023 09:21

How to run benchmark CI using PR label

1946d14

Merge branch 'main' into core_dev_guide2

e11e498

TomNicholas enabled auto-merge (squash) July 21, 2023 13:22

TomNicholas merged commit efa2863 into pydata:main Jul 21, 2023

TomNicholas deleted the core_dev_guide2 branch July 21, 2023 14:51

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Core team member guide #7999

Core team member guide #7999

TomNicholas commented Jul 18, 2023 •

edited

Loading

headtr1ck left a comment

shoyer commented Jul 18, 2023

TomNicholas commented Jul 18, 2023 •

edited

Loading

dcherian left a comment

TomNicholas commented Jul 18, 2023

jhamman left a comment

TomNicholas commented Jul 20, 2023 via email

Core team member guide #7999

Core team member guide #7999

Conversation

TomNicholas commented Jul 18, 2023 • edited Loading

headtr1ck left a comment

Choose a reason for hiding this comment

shoyer commented Jul 18, 2023

TomNicholas commented Jul 18, 2023 • edited Loading

dcherian left a comment

Choose a reason for hiding this comment

TomNicholas commented Jul 18, 2023

jhamman left a comment

Choose a reason for hiding this comment

TomNicholas commented Jul 20, 2023 via email

TomNicholas commented Jul 18, 2023 •

edited

Loading

TomNicholas commented Jul 18, 2023 •

edited

Loading