search

yt-project / yt

Main yt repository
http://yt-project.org
Other
468 stars 277 forks source link

MNT: a pull request template for new frontends #4614

Open neutrinoceros opened 1 year ago

neutrinoceros commented 1 year ago

The process of adding new frontends has a lot of steps that are not clear to (often new) contributors and easy to forget as maintainers. It would help if we had a specialised pull request template including a task list.

in particular, adding tests for new frontends is significantly more involved than regular tests because it implies storing sample data. This process ought to be better documented.

matthewturk commented 1 year ago

This is an awesome idea! I'd love to see if we can combine this with @chrishavlin 's skeleton of a frontend, and maybe really streamline the process.

chrishavlin commented 1 year ago

@matthewturk you mean https://github.com/data-exp-lab/ytcookiecutter ? i should check how that's working these days, it probably needs some updates....

and I like this idea too!

neutrinoceros commented 1 year ago

Another thing that I wanted to note: the checklist should include "create an 'extra' target for optional dependencies (even if you have none) in pyproject.toml" (all current frontends were merged before this became a thing, so we won't see it in existing examples)