From dde1e7cc09d6f8b262fffe22ea111243ece412cc Mon Sep 17 00:00:00 2001 From: Evan Rusackas Date: Mon, 23 Jan 2023 22:05:24 -0700 Subject: [PATCH] chore(issue templates): discouraging Issues for feature requests (#22617) --- .github/ISSUE_TEMPLATE/bug_report.md | 2 +- .github/ISSUE_TEMPLATE/feature_request.md | 14 -------------- .github/ISSUE_TEMPLATE/sip.md | 4 +++- CONTRIBUTING.md | 10 ++++++---- docs/docs/contributing/types-of-contributions.mdx | 8 +++++--- 5 files changed, 15 insertions(+), 23 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/feature_request.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 0e506cf9f..f821eb352 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -1,6 +1,6 @@ --- name: Bug report -about: Create a report to help us improve +about: Create a report to help us improve Superset's stability! For feature requests please open a discussion at https://github.com/apache/superset/discussions/categories/ideas labels: "#bug" --- diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index 8e6e0da9c..000000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -name: Feature request -about: Suggest an idea for this project -labels: "#enhancement" - ---- - -Github Discussions is our new home for discussing features and improvements! - -https://github.com/apache/superset/discussions/categories/ideas - -We'd like to keep Github Issues focuses on bugs and SIP's (Superset Improvement Proposals)! - -Please note that feature requests opened as Github Issues will be moved to Discussions. diff --git a/.github/ISSUE_TEMPLATE/sip.md b/.github/ISSUE_TEMPLATE/sip.md index e2a536b45..c2b0a14b9 100644 --- a/.github/ISSUE_TEMPLATE/sip.md +++ b/.github/ISSUE_TEMPLATE/sip.md @@ -1,7 +1,9 @@ --- name: SIP -about: Superset Improvement Proposal [See SIP-0](https://github.com/apache/superset/issues/5602) +about: Superset Improvement Proposal (See SIP-0: https://github.com/apache/superset/issues/5602) labels: "#SIP" +title: "[SIP] Your Title Here (do not add SIP number)" +asignees: "apache/superset-committers" --- diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5edd7804a..c8f72d2b2 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -126,7 +126,7 @@ Here's a list of repositories that contain Superset-related packages: ## Types of Contributions -### Report Bug +### Report a Bug The best way to report a bug is to file an issue on GitHub. Please include: @@ -138,15 +138,17 @@ The best way to report a bug is to file an issue on GitHub. Please include: When posting Python stack traces, please quote them using [Markdown blocks](https://help.github.com/articles/creating-and-highlighting-code-blocks/). +_Please note that feature requests opened as Github Issues will be moved to Discussions._ + ### Submit Ideas or Feature Requests -The best way is to file an issue on GitHub: +The best way is to start an ["Ideas" Discussion thread](https://github.com/apache/superset/discussions/categories/ideas) on GitHub: - Explain in detail how it would work. - Keep the scope as narrow as possible, to make it easier to implement. -- Remember that this is a volunteer-driven project, and that contributions are welcome :) +- Remember that this is a volunteer-driven project, and that your contributions are as welcome as anyone's :) -For large features or major changes to codebase, please create **Superset Improvement Proposal (SIP)**. See template from [SIP-0](https://github.com/apache/superset/issues/5602) +To propose large features or major changes to codebase, and help usher in those changes, please create a **Superset Improvement Proposal (SIP)**. See template from [SIP-0](https://github.com/apache/superset/issues/5602) ### Fix Bugs diff --git a/docs/docs/contributing/types-of-contributions.mdx b/docs/docs/contributing/types-of-contributions.mdx index a9fa907f5..cb6a5a5d8 100644 --- a/docs/docs/contributing/types-of-contributions.mdx +++ b/docs/docs/contributing/types-of-contributions.mdx @@ -19,15 +19,17 @@ The best way to report a bug is to file an issue on GitHub. Please include: When posting Python stack traces, please quote them using [Markdown blocks](https://help.github.com/articles/creating-and-highlighting-code-blocks/). +_Please note that feature requests opened as Github Issues will be moved to Discussions._ + ### Submit Ideas or Feature Requests -The best way is to file an issue on GitHub: +The best way is to start an ["Ideas" Discussion thread](https://github.com/apache/superset/discussions/categories/ideas) on GitHub: - Explain in detail how it would work. - Keep the scope as narrow as possible, to make it easier to implement. -- Remember that this is a volunteer-driven project, and that contributions are welcome :) +- Remember that this is a volunteer-driven project, and that your contributions are as welcome as anyone's :) -For large features or major changes to codebase, please create **Superset Improvement Proposal (SIP)**. See template from [SIP-0](https://github.com/apache/superset/issues/5602) +To propose large features or major changes to codebase, and help usher in those changes, please create a **Superset Improvement Proposal (SIP)**. See template from [SIP-0](https://github.com/apache/superset/issues/5602) ### Fix Bugs