Skip to content
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

Not all plugins have a dedicated CONTRIBUTING.md #364

Closed
astrojuanlu opened this issue Oct 3, 2023 · 1 comment · Fixed by #379
Closed

Not all plugins have a dedicated CONTRIBUTING.md #364

astrojuanlu opened this issue Oct 3, 2023 · 1 comment · Fixed by #379
Labels
documentation Improvements or additions to documentation

Comments

@astrojuanlu
Copy link
Member

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 astrojuanlu added the documentation Improvements or additions to documentation label Oct 3, 2023
@astrojuanlu
Copy link
Member Author

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...

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Archived in project
Development

Successfully merging a pull request may close this issue.

1 participant