From f9b16eba50568aeb9e993d5729ce9b6993631c07 Mon Sep 17 00:00:00 2001 From: chavlin Date: Wed, 11 Nov 2026 11:08:18 -0600 Subject: [PATCH] update contributing guidelines --- .github/PULL_REQUEST_TEMPLATE.md | 11 +++++++++++ CONTRIBUTING.md | 21 +++++++++++++++++++-- docs/contributing.rst | 13 +++++++------ 3 files changed, 37 insertions(+), 8 deletions(-) create mode 100644 .github/PULL_REQUEST_TEMPLATE.md diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..6dfc1e2 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,11 @@ +## Description + + + +## Related issue + + + +## Checklist + +- [ ] I have read [CONTRIBUTING.md](https://github.com/data-exp-lab/yt_xarray/blob/main/CONTRIBUTING.md) and this PR follows the contribution policy. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0955fe3..d77393d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,5 +1,22 @@ ## Contributing -Contributions are welcome! +Contributions are welcome, especially from people who use yt_xarray in +their own work. If you've hit a bug, need a feature, or found the docs +confusing, we'd like to hear from you. -See [here](https://yt-xarray.readthedocs.io/en/latest/contributing.html) for how to get involved. +To keep maintenance manageable, please note: + +- **Open an issue first.** Describe what you're trying to do with + yt_xarray and what you'd like to change. Small fixes for problems you ran + into yourself (typos, broken examples) are fine as a direct PR. +- **Unsolicited PRs without prior discussion may be closed without review.** + This includes PRs that pick up an open issue without commenting on it + first, and PRs with no apparent connection to using the package. +- **AI-generated PRs from new contributors are not allowed** and will be + closed. +- **This project is not a good fit for coursework or contribution-count + PRs.** Maintainer time is limited, and we prioritize changes that come + from real use. + +See [the contributing guide](https://yt-xarray.readthedocs.io/en/latest/contributing.html) +for development setup and workflow. diff --git a/docs/contributing.rst b/docs/contributing.rst index d243b72..97ba2db 100644 --- a/docs/contributing.rst +++ b/docs/contributing.rst @@ -1,8 +1,9 @@ Contributing ============ -Contributions are welcome, and they are greatly appreciated! Every little bit -helps, and credit will always be given. +Contributions are welcome, especially from people who use yt_xarray in their +own work. Before opening a pull request, please read the contribution policy in +`CONTRIBUTING.md `_. You can contribute in many ways: @@ -23,14 +24,14 @@ If you are reporting a bug, please include: Fix Bugs ******** -Look through the GitHub issues for bugs. Anything tagged with "bug" and "help -wanted" is open to whoever wants to implement it. +Look through the GitHub issues for bugs. If you'd like to work on one, comment +on the issue first. Implement Features ****************** -Look through the GitHub issues for features. Anything tagged with "enhancement" -and "help wanted" is open to whoever wants to implement it. +Look through the GitHub issues for features. If you'd like to work on one, +comment on the issue first. Write Documentation *******************