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

Fix Contributing Guide across kedro, kedro-plugins #2667

Closed
noklam opened this issue Jun 12, 2023 · 5 comments · Fixed by #2894 or #2914
Closed

Fix Contributing Guide across kedro, kedro-plugins #2667

noklam opened this issue Jun 12, 2023 · 5 comments · Fixed by #2894 or #2914
Assignees
Labels
Component: Documentation 📄 Issue/PR for markdown and API documentation Issue: Feature Request New feature or improvement to existing feature

Comments

@noklam
Copy link
Contributor

noklam commented Jun 12, 2023

Description

Is your feature request related to a problem? A clear and concise description of what the problem is: "I'm always frustrated when ..."

Re-assess CONTRIBUTING.md in both kedro, kedro-plugins and the documentation to make sure this is easy enough for developers to setup a local development environment

Context

Why is this change important to you? How would you use it? How can it benefit other users?

Possible Implementation

(Optional) Suggest an idea for implementing the addition or change.

Possible Alternatives

(Optional) Describe any alternative solutions or features you've considered.

@noklam noklam added the Issue: Feature Request New feature or improvement to existing feature label Jun 12, 2023
@noklam noklam self-assigned this Jun 12, 2023
@stichbury stichbury added the Component: Documentation 📄 Issue/PR for markdown and API documentation label Jun 12, 2023
@stichbury
Copy link
Contributor

I think we definitely need to make a few updates to https://docs.kedro.org/en/latest/contribution/index.html to align the content in the page with the table of contents and also make this documentation page consistent with the separate markdown in CONTRIBUTING.md

@astrojuanlu
Copy link
Member

I'm on the fence about that, maybe we should remove that page completely as we said in #2376

But definitely we could have a section, say, on GitHub Wiki, and make the CONTRIBUTING.md files pretty minimal, with a link there that we can update without going through the toil of CI.

@merelcht
Copy link
Member

We need to clarify what types of contributions we accept, specifically for kedro-plugins mention that dataset additions are the most likely to get accepted. But of course don't discourage anyone from helping out on kedro-airflow etc.

@stichbury
Copy link
Contributor

stichbury commented Jul 25, 2023

I won't tackle this but it's a good ticket if anyone wants to learn more about our contribution process and pick up some docs writing experience.

@astrojuanlu
Copy link
Member

One thing that came up after talking with @laizaparizotto: our make test plugin=x for kedro-plugins is not documented anywhere right? Or am I missing something?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment