-
-
Notifications
You must be signed in to change notification settings - Fork 1.1k
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
Core team member guide #7999
Conversation
There was a problem hiding this 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 :)
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>
Okay I've addressed all the comments so far, reorganised, and included sections on issue triage from the pandas maintainers guide. |
There was a problem hiding this 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
Co-authored-by: Deepak Cherian <dcherian@users.noreply.github.com>
😁
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. |
There was a problem hiding this 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.
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
…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) ...
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 #xxxxTests addedwhats-new.rst
New functions/methods are listed inapi.rst