docs: Add CONTRIBUTING.md file to the Kedro-Plugins repository #294

lrcouto · 2023-08-03T18:06:33Z

Description

Part of the solution for issue #2667. Adds a CONTRIBUTING.md file to the Kedro-Plugins repository, linking to the contributing guide on the wiki.

Development notes

Checklist

Opened this PR as a 'Draft Pull Request' if it is work-in-progress
Updated the documentation to reflect the code changes
Added a description of this change in the relevant RELEASE.md file
Added tests to cover my changes

noklam

Is this identical to the kedro contributor.md now?

kedro-org/kedro#2667 (comment)

Is this comment addressed?

lrcouto · 2023-08-03T21:33:46Z

At this moment, yes, it's identical to the file on the Kedro repo.

I've added a "Which contributions are likely to be accepted?" section to the wiki page to address Merel's comment.

stichbury

I suggest for now that you take the version you ultimately merge from kedro-org/kedro#2894 and use this, but also take this on board from @merelcht and add a section specific to the kedro-plugins repo. kedro-org/kedro#2667 (comment)

merelcht · 2023-08-15T09:13:43Z

I think this looks good, but as @stichbury said above it would be good to add a section about kedro-plugins contributions specifically similar to https://github.com/kedro-org/kedro/wiki/Contribute-to-Kedro#which-contributions-are-likely-to-be-accepted

Signed-off-by: lrcouto <laurarccouto@gmail.com>

#302) * Fix pyproject.toml syntax for optional dependencies Signed-off-by: Dmitry Sorokin <dmd40in@gmail.com> * refacor out the base dependencies Signed-off-by: Nok <nok.lam.chan@quantumblack.com> * add comments Signed-off-by: Nok <nok.lam.chan@quantumblack.com> * format pyproject.toml Signed-off-by: Nok <nok.lam.chan@quantumblack.com> * Reorder pandas dependencies Signed-off-by: Nok <nok.lam.chan@quantumblack.com> * reorder spark dependencies Signed-off-by: Nok <nok.lam.chan@quantumblack.com> * remove polars-base and delta-base Signed-off-by: Nok <nok.lam.chan@quantumblack.com> --------- Signed-off-by: Dmitry Sorokin <dmd40in@gmail.com> Signed-off-by: Nok <nok.lam.chan@quantumblack.com> Co-authored-by: Nok <nok.lam.chan@quantumblack.com> Signed-off-by: lrcouto <laurarccouto@gmail.com>

Signed-off-by: lrcouto <laurarccouto@gmail.com>

Signed-off-by: L. R. Couto <laurarccouto@gmail.com> Signed-off-by: lrcouto <laurarccouto@gmail.com>

fix broken link to datasets docs Signed-off-by: Jo Stichbury <jo_stichbury@mckinsey.com> Signed-off-by: lrcouto <laurarccouto@gmail.com>

* Try adding docs rtd check on kedro datasets Signed-off-by: Merel Theisen <merel.theisen@quantumblack.com> * Add Read the Docs configuration for kedro-datasets Signed-off-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com> Signed-off-by: lrcouto <laurarccouto@gmail.com>

#301) * fix(datasets): do not double encode the data as json when saving an APIDataSet Signed-off-by: Florian Gaudin-Delrieu <fgaudindelrieu@idmog.com> Signed-off-by: Florian Gaudin-Delrieu <florian.gaudindelrieu@gmail.com> * chore(lint): make pyling happy Signed-off-by: Florian Gaudin-Delrieu <florian.gaudindelrieu@gmail.com> --------- Signed-off-by: Florian Gaudin-Delrieu <fgaudindelrieu@idmog.com> Signed-off-by: Florian Gaudin-Delrieu <florian.gaudindelrieu@gmail.com> Co-authored-by: Nok Lam Chan <nok.lam.chan@quantumblack.com> Signed-off-by: lrcouto <laurarccouto@gmail.com>

* release 1.5.2 minor release to fix the kedro-datasets optional dependencies issue * Update RELEASE.md * Trim whitespace Signed-off-by: Nok <nok.lam.chan@quantumblack.com> --------- Signed-off-by: Nok <nok.lam.chan@quantumblack.com> Signed-off-by: lrcouto <laurarccouto@gmail.com>

Signed-off-by: lrcouto <laurarccouto@gmail.com>

merelcht

LGTM! 👍

astrojuanlu

Looks wonderful! Left some nitpicks and comments

CONTRIBUTING.md

Co-authored-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com>

Signed-off-by: lrcouto <laurarccouto@gmail.com>

Signed-off-by: L. R. Couto <laurarccouto@gmail.com>

astrojuanlu · 2023-08-18T23:18:04Z

CONTRIBUTING.md

@@ -15,12 +15,12 @@ We also curate a [GitHub repo that lists content created by the Kedro community]
 ## Contribute to the project

 There are quite a few ways to contribute to Kedro, such as answering questions about Kedro to help others, fixing a typo on the documentation, reporting a bug, reviewing pull requests or adding a feature.
-
+ls


stichbury

LGTM 🌟

astrojuanlu · 2023-08-22T17:12:32Z

Blocked by #295

…-org#294) * Add CONTRIBUTING.md file to the Kedro-Plugins repository Signed-off-by: lrcouto <laurarccouto@gmail.com> * fix(datasets): Correct pyproject.toml syntax for optional dependencies (kedro-org#302) * Fix pyproject.toml syntax for optional dependencies Signed-off-by: Dmitry Sorokin <dmd40in@gmail.com> * refacor out the base dependencies Signed-off-by: Nok <nok.lam.chan@quantumblack.com> * add comments Signed-off-by: Nok <nok.lam.chan@quantumblack.com> * format pyproject.toml Signed-off-by: Nok <nok.lam.chan@quantumblack.com> * Reorder pandas dependencies Signed-off-by: Nok <nok.lam.chan@quantumblack.com> * reorder spark dependencies Signed-off-by: Nok <nok.lam.chan@quantumblack.com> * remove polars-base and delta-base Signed-off-by: Nok <nok.lam.chan@quantumblack.com> --------- Signed-off-by: Dmitry Sorokin <dmd40in@gmail.com> Signed-off-by: Nok <nok.lam.chan@quantumblack.com> Co-authored-by: Nok <nok.lam.chan@quantumblack.com> Signed-off-by: lrcouto <laurarccouto@gmail.com> * Bring CONTRIBUTING.md file in line with the one on the main Kedro repo Signed-off-by: lrcouto <laurarccouto@gmail.com> * Bring CONTRIBUTING.md file in line with the one on the main Kedro repo Signed-off-by: L. R. Couto <laurarccouto@gmail.com> Signed-off-by: lrcouto <laurarccouto@gmail.com> * docs: Fix broken link to datasets docs in README.md (kedro-org#304) fix broken link to datasets docs Signed-off-by: Jo Stichbury <jo_stichbury@mckinsey.com> Signed-off-by: lrcouto <laurarccouto@gmail.com> * ci: Add docs rtd check on `kedro-datasets` (kedro-org#299) * Try adding docs rtd check on kedro datasets Signed-off-by: Merel Theisen <merel.theisen@quantumblack.com> * Add Read the Docs configuration for kedro-datasets Signed-off-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com> Signed-off-by: lrcouto <laurarccouto@gmail.com> * fix(datasets): do not double encode the data as json when saving an A… (kedro-org#301) * fix(datasets): do not double encode the data as json when saving an APIDataSet Signed-off-by: Florian Gaudin-Delrieu <fgaudindelrieu@idmog.com> Signed-off-by: Florian Gaudin-Delrieu <florian.gaudindelrieu@gmail.com> * chore(lint): make pyling happy Signed-off-by: Florian Gaudin-Delrieu <florian.gaudindelrieu@gmail.com> --------- Signed-off-by: Florian Gaudin-Delrieu <fgaudindelrieu@idmog.com> Signed-off-by: Florian Gaudin-Delrieu <florian.gaudindelrieu@gmail.com> Co-authored-by: Nok Lam Chan <nok.lam.chan@quantumblack.com> Signed-off-by: lrcouto <laurarccouto@gmail.com> * build(datasets): release 1.5.2 (kedro-org#305) * release 1.5.2 minor release to fix the kedro-datasets optional dependencies issue * Update RELEASE.md * Trim whitespace Signed-off-by: Nok <nok.lam.chan@quantumblack.com> --------- Signed-off-by: Nok <nok.lam.chan@quantumblack.com> Signed-off-by: lrcouto <laurarccouto@gmail.com> * Add plugin contribution details to CONTRIBUTING.md Signed-off-by: lrcouto <laurarccouto@gmail.com> * Update CONTRIBUTING.md Co-authored-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com> * Update CONTRIBUTING.md Co-authored-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com> * Apply minor changes on CONTRIBUTING.md Signed-off-by: lrcouto <laurarccouto@gmail.com> * Push code of conduct text block to the top on CONTRIBUTING.md Signed-off-by: L. R. Couto <laurarccouto@gmail.com> * Fix trailing whitespace lint error Signed-off-by: L. R. Couto <laurarccouto@gmail.com> --------- Signed-off-by: lrcouto <laurarccouto@gmail.com> Signed-off-by: Dmitry Sorokin <dmd40in@gmail.com> Signed-off-by: Nok <nok.lam.chan@quantumblack.com> Signed-off-by: L. R. Couto <laurarccouto@gmail.com> Signed-off-by: Jo Stichbury <jo_stichbury@mckinsey.com> Signed-off-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com> Signed-off-by: Florian Gaudin-Delrieu <fgaudindelrieu@idmog.com> Signed-off-by: Florian Gaudin-Delrieu <florian.gaudindelrieu@gmail.com> Co-authored-by: Dmitry Sorokin <40151847+DimedS@users.noreply.github.com> Co-authored-by: Nok <nok.lam.chan@quantumblack.com> Co-authored-by: Jo Stichbury <jo_stichbury@mckinsey.com> Co-authored-by: Merel Theisen <49397448+merelcht@users.noreply.github.com> Co-authored-by: Florian Gaudin-Delrieu <9217921+FlorianGD@users.noreply.github.com> Co-authored-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com>

lrcouto requested review from stichbury, noklam and merelcht August 3, 2023 18:07

noklam reviewed Aug 3, 2023

View reviewed changes

stichbury suggested changes Aug 7, 2023

View reviewed changes

merelcht mentioned this pull request Aug 14, 2023

docs: Create CONTRIBUTING.md #230

Closed

4 tasks

lrcouto changed the title ~~Add CONTRIBUTING.md file to the Kedro-Plugins repository~~ docs: Add CONTRIBUTING.md file to the Kedro-Plugins repository Aug 15, 2023

lrcouto and others added 9 commits August 15, 2023 17:34

Add CONTRIBUTING.md file to the Kedro-Plugins repository

b242a39

Signed-off-by: lrcouto <laurarccouto@gmail.com>

Bring CONTRIBUTING.md file in line with the one on the main Kedro repo

27d590d

Signed-off-by: lrcouto <laurarccouto@gmail.com>

Bring CONTRIBUTING.md file in line with the one on the main Kedro repo

41a9aa5

Signed-off-by: L. R. Couto <laurarccouto@gmail.com> Signed-off-by: lrcouto <laurarccouto@gmail.com>

docs: Fix broken link to datasets docs in README.md (#304)

cd778c1

fix broken link to datasets docs Signed-off-by: Jo Stichbury <jo_stichbury@mckinsey.com> Signed-off-by: lrcouto <laurarccouto@gmail.com>

Add plugin contribution details to CONTRIBUTING.md

f3797ce

Signed-off-by: lrcouto <laurarccouto@gmail.com>

lrcouto force-pushed the docs/add-contributing-guide branch from 37eb37e to f3797ce Compare August 15, 2023 20:34

Merge branch 'main' into docs/add-contributing-guide

4c63d56

astrojuanlu self-requested a review August 16, 2023 16:10

merelcht approved these changes Aug 17, 2023

View reviewed changes

merelcht requested a review from stichbury August 17, 2023 10:26

astrojuanlu approved these changes Aug 17, 2023

View reviewed changes

CONTRIBUTING.md Outdated Show resolved Hide resolved

CONTRIBUTING.md Outdated Show resolved Hide resolved

CONTRIBUTING.md Outdated Show resolved Hide resolved

CONTRIBUTING.md Outdated Show resolved Hide resolved

stichbury and others added 6 commits August 17, 2023 12:40

Update CONTRIBUTING.md

cc266de

Co-authored-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com>

Update CONTRIBUTING.md

0de8d14

Co-authored-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com>

Merge branch 'main' into docs/add-contributing-guide

74e1770

Merge branch 'main' into docs/add-contributing-guide

5511946

Apply minor changes on CONTRIBUTING.md

a889a06

Signed-off-by: lrcouto <laurarccouto@gmail.com>

Merge branch 'main' into docs/add-contributing-guide

bdd9309

lrcouto added 2 commits August 18, 2023 12:43

Push code of conduct text block to the top on CONTRIBUTING.md

d66ada9

Signed-off-by: L. R. Couto <laurarccouto@gmail.com>

Fix trailing whitespace lint error

22717bc

Signed-off-by: L. R. Couto <laurarccouto@gmail.com>

lrcouto enabled auto-merge (squash) August 18, 2023 18:53

astrojuanlu reviewed Aug 18, 2023

View reviewed changes

stichbury approved these changes Aug 21, 2023

View reviewed changes

Merge branch 'main' into docs/add-contributing-guide

b7a7edb

lrcouto merged commit 3d20cdb into main Aug 24, 2023
56 checks passed

lrcouto deleted the docs/add-contributing-guide branch August 24, 2023 07:43

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: Add CONTRIBUTING.md file to the Kedro-Plugins repository #294

docs: Add CONTRIBUTING.md file to the Kedro-Plugins repository #294

lrcouto commented Aug 3, 2023

noklam left a comment

lrcouto commented Aug 3, 2023

stichbury left a comment •

edited

Loading

merelcht commented Aug 15, 2023

merelcht left a comment

astrojuanlu left a comment

astrojuanlu Aug 18, 2023

stichbury left a comment

astrojuanlu commented Aug 22, 2023

docs: Add CONTRIBUTING.md file to the Kedro-Plugins repository #294

docs: Add CONTRIBUTING.md file to the Kedro-Plugins repository #294

Conversation

lrcouto commented Aug 3, 2023

Description

Development notes

Checklist

noklam left a comment

Choose a reason for hiding this comment

lrcouto commented Aug 3, 2023

stichbury left a comment • edited Loading

Choose a reason for hiding this comment

merelcht commented Aug 15, 2023

merelcht left a comment

Choose a reason for hiding this comment

astrojuanlu left a comment

Choose a reason for hiding this comment

astrojuanlu Aug 18, 2023

Choose a reason for hiding this comment

stichbury left a comment

Choose a reason for hiding this comment

astrojuanlu commented Aug 22, 2023

stichbury left a comment •

edited

Loading