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

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

Merged
merged 19 commits into from
Aug 24, 2023

Conversation

lrcouto
Copy link
Contributor

@lrcouto lrcouto commented Aug 3, 2023

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

Copy link
Contributor

@noklam noklam left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this identical to the kedro contributor.md now?

kedro-org/kedro#2667 (comment)

Is this comment addressed?

@lrcouto
Copy link
Contributor Author

lrcouto commented Aug 3, 2023

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.

Copy link
Contributor

@stichbury stichbury left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 merelcht mentioned this pull request Aug 14, 2023
4 tasks
@merelcht
Copy link
Member

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

@lrcouto 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
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>
@lrcouto lrcouto force-pushed the docs/add-contributing-guide branch from 37eb37e to f3797ce Compare August 15, 2023 20:34
@astrojuanlu astrojuanlu self-requested a review August 16, 2023 16:10
Copy link
Member

@merelcht merelcht left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! 👍

Copy link
Member

@astrojuanlu astrojuanlu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks wonderful! Left some nitpicks and comments

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
Co-authored-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com>
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>
Signed-off-by: L. R. Couto <laurarccouto@gmail.com>
@lrcouto lrcouto enabled auto-merge (squash) August 18, 2023 18:53
@@ -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
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Typo!

Copy link
Contributor

@stichbury stichbury left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM 🌟

@astrojuanlu
Copy link
Member

Blocked by #295

@lrcouto lrcouto merged commit 3d20cdb into main Aug 24, 2023
56 checks passed
@lrcouto lrcouto deleted the docs/add-contributing-guide branch August 24, 2023 07:43
PtrBld pushed a commit to PtrBld/kedro-plugins that referenced this pull request Aug 27, 2023
…-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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

7 participants