Not all plugins have a dedicated `CONTRIBUTING.md` - Githubissues

kedro-org / kedro-plugins

First-party plugins maintained by the Kedro team.

Apache License 2.0

92 stars 89 forks source link

Not all plugins have a dedicated `CONTRIBUTING.md` #364

Closed astrojuanlu closed 1 year ago

astrojuanlu commented 1 year ago

Description

I was confused when I saw that kedro-docker has a CONTRIBUTING.md https://github.com/kedro-org/kedro-plugins/blob/main/kedro-docker/CONTRIBUTING.md

but kedro-datasets doesn't.

On the other hand, the top-level CONTRIBUTING.md does not explain how to run the tests, but the kedro-docker specific one does https://github.com/kedro-org/kedro-plugins/blob/main/kedro-docker/CONTRIBUTING.md#ci--cd-and-running-checks-locally

Context

I was trying to tell a contributor (#355) how to run the tests only for one dataset.

astrojuanlu commented 1 year ago

Also, maybe instead of make test, we could tell contributors to run pytest? It's not only more explicit, it's actually faster to type...