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
Merged
Changes from all commits
Commits
Show all changes
19 commits
Select commit Hold shift + click to select a range
b242a39
Add CONTRIBUTING.md file to the Kedro-Plugins repository
lrcouto Aug 3, 2023
d82a6df
fix(datasets): Correct pyproject.toml syntax for optional dependencie…
DimedS Aug 14, 2023
27d590d
Bring CONTRIBUTING.md file in line with the one on the main Kedro repo
lrcouto Aug 14, 2023
41a9aa5
Bring CONTRIBUTING.md file in line with the one on the main Kedro repo
lrcouto Aug 14, 2023
cd778c1
docs: Fix broken link to datasets docs in README.md (#304)
stichbury Aug 15, 2023
3acd1b0
ci: Add docs rtd check on `kedro-datasets` (#299)
merelcht Aug 15, 2023
162407c
fix(datasets): do not double encode the data as json when saving an A…
FlorianGD Aug 15, 2023
a1331ec
build(datasets): release 1.5.2 (#305)
noklam Aug 15, 2023
f3797ce
Add plugin contribution details to CONTRIBUTING.md
lrcouto Aug 15, 2023
4c63d56
Merge branch 'main' into docs/add-contributing-guide
lrcouto Aug 15, 2023
cc266de
Update CONTRIBUTING.md
stichbury Aug 17, 2023
0de8d14
Update CONTRIBUTING.md
stichbury Aug 17, 2023
74e1770
Merge branch 'main' into docs/add-contributing-guide
lrcouto Aug 17, 2023
5511946
Merge branch 'main' into docs/add-contributing-guide
lrcouto Aug 17, 2023
a889a06
Apply minor changes on CONTRIBUTING.md
lrcouto Aug 17, 2023
bdd9309
Merge branch 'main' into docs/add-contributing-guide
lrcouto Aug 18, 2023
d66ada9
Push code of conduct text block to the top on CONTRIBUTING.md
lrcouto Aug 18, 2023
22717bc
Fix trailing whitespace lint error
lrcouto Aug 18, 2023
b7a7edb
Merge branch 'main' into docs/add-contributing-guide
astrojuanlu Aug 24, 2023
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 34 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# Introduction

We welcome any and all contributions to Kedro, at whatever level you can manage. Here are a few suggestions, and you are welcome to suggest anything else that you think improves the community for us all!

## Code of conduct

The Kedro team pledges to foster and maintain a friendly community. We enforce a [Code of Conduct](./CODE_OF_CONDUCT.md) to ensure every Kedroid is welcomed and treated with respect.

## Join the community

You can find the Kedro community on our [Slack organisation](https://slack.kedro.org/), which is where we share news and announcements, and answer technical questions. You're welcome to post links to any articles or videos about Kedro that you create or find, such as how-tos, showcases, demos, blog posts or tutorials.

We also curate a [GitHub repo that lists content created by the Kedro community](https://github.com/kedro-org/awesome-kedro). If you've made something with Kedro, simply add it to the list with a PR!

## 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!

Take a look at some of our [contribution suggestions on the Kedro GitHub Wiki](https://github.com/kedro-org/kedro/wiki/Contribute-to-Kedro)!

## Which plugin contributions are likely to be accepted?

Dataset contributions to the [Kedro-Datasets](https://github.com/kedro-org/kedro-plugins/tree/main/kedro-datasets) plugin are the most frequently accepted, since they do not require any changes to the framework itself.

However, we accept contributions to any of the other [Kedro-Plugins](https://github.com/kedro-org/kedro-plugins) or the framework or `Kedro-Viz`. As a guide, contributions based on existing issues from the Kedro team, or issues that the team has deemed useful, are most likely to be accepted. Any contributions that affect fundamental changes to the Kedro Framework would require discussion first. In this case, we recommend opening an issue instead of a pull request.

Make sure to check out the contributing guides for [Kedro-Docker](https://github.com/kedro-org/kedro-plugins/blob/main/kedro-docker/CONTRIBUTING.md) and [Kedro-Airflow](https://github.com/kedro-org/kedro-plugins/blob/main/kedro-airflow/CONTRIBUTING.md) if you intend to contribute to those specific plugins.

## Join the Technical Steering Committee
Kedro is an incubating project in [LF AI & Data](https://lfaidata.foundation/), a sub-organisation within the Linux Foundation that focuses on open innovation within the data and AI space.

The project is governed by a group of maintainers, known as the Technical Steering Committee (TSC); read more about the structure of our TSC in our [Technical Charter](./kedro_technical_charter.pdf).

We regularly invite community members to join the TSC and help define the future of the Kedro project. Read the [guidance on becoming a Kedro maintainer](https://docs.kedro.org/en/stable/contribution/technical_steering_committee.html) to understand the process of joining the TSC.