diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index 37923fa5b0..c545302842 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -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 diff --git a/.github/ISSUE_TEMPLATE/doc-improvement.md b/.github/ISSUE_TEMPLATE/doc-improvement.md index 64523d37bc..5a85c44a13 100644 --- a/.github/ISSUE_TEMPLATE/doc-improvement.md +++ b/.github/ISSUE_TEMPLATE/doc-improvement.md @@ -6,10 +6,10 @@ labels: 'Component: Documentation' --- ## Description - + ### Documentation page (if applicable) ## Context - + diff --git a/.github/ISSUE_TEMPLATE/feature-request.md b/.github/ISSUE_TEMPLATE/feature-request.md deleted file mode 100644 index b52de098bd..0000000000 --- a/.github/ISSUE_TEMPLATE/feature-request.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -name: Feature request -about: Let us know if you have a feature request or enhancement -title: '' -labels: 'Issue: Feature Request' -assignees: '' - ---- - -## Description -<!-- Is your feature request related to a problem? A clear and concise description of what the problem is: "I'm always frustrated when ..." --> - -## 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. --> diff --git a/.github/ISSUE_TEMPLATE/software_design_proposal.md b/.github/ISSUE_TEMPLATE/software_design_proposal.md deleted file mode 100644 index 3b200468f5..0000000000 --- a/.github/ISSUE_TEMPLATE/software_design_proposal.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -name: Software design proposal -about: To propose and request comments on a software design decision -title: '<Title>' -labels: 'Type: Design Proposal' -assignees: '' - ---- - -## Introduction -<!-- A high-level, short overview of the problem(s) you are designing a solution for. --> - -## Background -<!-- Provide the reader with the context surrounding the problem(s) you are trying to solve. --> - -## Problem -<!-- Be as concrete as you can about: --> - -### What's in scope - -### What's not in scope - -## Design -<!-- Explain your design to the solution here. Diagrams could help. --> - -### Alternatives considered -<!-- Explain the trade off between different alternatives to your solution. --> - -## Testing -<!-- Explain the testing strategies to verify your design correctness (if possible). --> - -## Rollout strategy -<!-- Is the change backward compatible? If not, what is the migration strategy? --> - -## Future iterations -<!-- Will there be future iterations of this design? --> diff --git a/.github/stale.yml b/.github/stale.yml deleted file mode 100644 index 2e0a4c333c..0000000000 --- a/.github/stale.yml +++ /dev/null @@ -1,20 +0,0 @@ -# Number of days of inactivity before an issue becomes stale -daysUntilStale: 60 -# Number of days of inactivity before a stale issue is closed -daysUntilClose: 7 -# Only issues or pull requests with all of these labels are checked if stale. Defaults to `[]` (disabled) -onlyLabels: - - Community -# Issues with these labels will never be considered stale -exemptLabels: - - pinned - - security -# Label to use when marking an issue as stale -staleLabel: stale -# Comment to post when marking an issue as stale. Set to `false` to disable -markComment: > - This issue has been automatically marked as stale because it has not had - recent activity. It will be closed if no further activity occurs. Thank you - for your contributions. -# Comment to post when closing a stale issue. Set to `false` to disable -closeComment: false diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6eeb6532ba..18ba1072e9 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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 @@ -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). diff --git a/README.md b/README.md index 756d65d84b..67bd6d4eef 100644 --- a/README.md +++ b/README.md @@ -86,6 +86,14 @@ Find out more about how Kedro can answer your use cases from the [product FAQs o 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. + +## 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).