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

Update contributing and README with new support scheme #3819

Closed
wants to merge 4 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
13 changes: 5 additions & 8 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -1,11 +1,8 @@
blank_issues_enabled: false
contact_links:
- name: Slack organisation
about: Come chat with the community!
- name: Suggest a new feature
about: Feature request, enhancement idea, new functionality? Open a discussion!
url: https://github.com/kedro-org/kedro/discussions/new?category=idea
- name: Ask for help
about: Come chat with the community in Slack!
url: https://slack.kedro.org/
- name: Documentation
url: https://kedro.readthedocs.io/en/stable/
about: To learn more about how Kedro works
- name: Website
url: https://kedro.org/
about: Learn about features, project examples and our demo
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/doc-improvement.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,10 @@ labels: 'Component: Documentation'
---

## Description
<!-- Short description of the improvement suggestion. -->
<!-- Short description of the improvement suggestion -->

### Documentation page (if applicable)
<!-- https://docs.kedro.org/en/stable/... -->

## Context
<!-- Extra context. -->
<!-- Extra context -->
20 changes: 0 additions & 20 deletions .github/ISSUE_TEMPLATE/feature-request.md

This file was deleted.

36 changes: 0 additions & 36 deletions .github/ISSUE_TEMPLATE/software_design_proposal.md

This file was deleted.

20 changes: 0 additions & 20 deletions .github/stale.yml

This file was deleted.

3 changes: 3 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ We welcome any and all contributions to Kedro, at whatever level you can manage.

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.

## Share something you've done

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
Expand All @@ -15,6 +17,7 @@ There are quite a few ways to contribute to Kedro, such as answering questions a
Take a look at some of our [contribution suggestions on the Kedro GitHub Wiki](https://github.com/kedro-org/kedro/wiki/Contribute-to-Kedro)!

## 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).
Expand Down
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,14 @@

The [Kedro product team](https://docs.kedro.org/en/stable/contribution/technical_steering_committee.html#kedro-maintainers) and a number of [open source contributors from across the world](https://github.com/kedro-org/kedro/releases) maintain Kedro.

## Get support

To get support, we recommend you to join our [Slack workspace](https://slack.kedro.org/) and write a message in the `#questions` channel. Alternatively, you can [open an issue](https://github.com/kedro-org/kedro/issues/new?assignees=&labels=Issue%3A+Bug+Report&template=bug-report.md) on GitHub directly.

Check warning on line 91 in README.md

View workflow job for this annotation

GitHub Actions / vale

[vale] README.md#L91

[Kedro.toowordy] 'Alternatively' is too wordy
Raw output
{"message": "[Kedro.toowordy] 'Alternatively' is too wordy", "location": {"path": "README.md", "range": {"start": {"line": 91, "column": 139}}}, "severity": "WARNING"}

Check warning on line 91 in README.md

View workflow job for this annotation

GitHub Actions / vale

[vale] README.md#L91

[Kedro.weaselwords] 'Alternatively' is a weasel word!
Raw output
{"message": "[Kedro.weaselwords] 'Alternatively' is a weasel word!", "location": {"path": "README.md", "range": {"start": {"line": 91, "column": 139}}}, "severity": "WARNING"}

## Suggest a new idea

We use [GitHub Discussions](https://github.com/kedro-org/kedro/discussions) to discuss about possible ideas for improvement, new features, feature requests, and such. If you have a suggestion, feel free to [open a new discussion](https://github.com/kedro-org/kedro/discussions/new?category=idea).

## Can I contribute?

Yes! We welcome all kinds of contributions. Check out our [guide to contributing to Kedro](https://github.com/kedro-org/kedro/wiki/Contribute-to-Kedro).
Expand Down
Loading