Skip to content

update contributing guidelines #171

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.

Sign up for GitHub

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

Merged
chrishavlin merged 1 commit into from
Nov 11, 2026
Merged

update contributing guidelines #171

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
## Description

<!-- What does this PR change, and why? -->

## Related issue

<!-- Link the issue where this change was discussed, e.g. "Closes #123". -->

## 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.
21 changes: 19 additions & 2 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.
13 changes: 7 additions & 6 deletions docs/contributing.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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 <https://github.com/data-exp-lab/yt_xarray/blob/main/CONTRIBUTING.md>`_.

You can contribute in many ways:

Expand All @@ -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
*******************
Expand Down
Loading