From 7000e8c898a87aa7c699a02b3f207da78812be4b Mon Sep 17 00:00:00 2001 From: Teresa Romero Date: Tue, 2 Dec 2025 13:03:02 +0100 Subject: [PATCH 1/3] Add Category Proposal issue template and update CONTRIBUTING.md for category proposals --- .github/ISSUE_TEMPLATE/Category_Proposal.md | 21 +++++++++++++++++++++ CONTRIBUTING.md | 3 +++ 2 files changed, 24 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/Category_Proposal.md diff --git a/.github/ISSUE_TEMPLATE/Category_Proposal.md b/.github/ISSUE_TEMPLATE/Category_Proposal.md new file mode 100644 index 000000000..34d83b6b0 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/Category_Proposal.md @@ -0,0 +1,21 @@ +--- +name: Category Proposal +about: For proposing and discussing a change to the list of categories available under the Elastic Package Specification +labels: discuss +title: "[Category Proposal] " +--- + +## Context + + + +## Implementation checklist + + + +- [] Support in package-spec manifest categories +- [] Support in package-registry /categories API +- [] Support in Fleet +- [] Update integrations dependencies to support new category diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 79f00c829..486391394 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -29,6 +29,9 @@ something like this: 5. No single PR may close the proposal issue. But as these PRs get resolved, the corresponding checklist item should be checked off. The proposal issue is closed when all items are checked off. +## Category Proposals + +Specific changes regarding categories can please use the [new Category Proposal issue](https://github.com/elastic/package-spec/issues/new/choose). ## Folder Item spec From 38edc23f208452b4724db6ec1ea722fb5078c10e Mon Sep 17 00:00:00 2001 From: Teresa Romero Date: Tue, 2 Dec 2025 15:47:38 +0100 Subject: [PATCH 2/3] Update Category Proposal template and CONTRIBUTING.md for clarity on eligibility requirements and proposal process --- .github/ISSUE_TEMPLATE/Category_Proposal.md | 30 +++++++++++++++------ CONTRIBUTING.md | 13 ++++++++- 2 files changed, 34 insertions(+), 9 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/Category_Proposal.md b/.github/ISSUE_TEMPLATE/Category_Proposal.md index 34d83b6b0..48c989259 100644 --- a/.github/ISSUE_TEMPLATE/Category_Proposal.md +++ b/.github/ISSUE_TEMPLATE/Category_Proposal.md @@ -5,17 +5,31 @@ labels: discuss title: "[Category Proposal] " --- +*Please read the section on [Category Proposals in the Contributing Guide](../../CONTRIBUTING.md#category-proposals) and flesh out this issue accordingly. Thank you!* + ## Context -## Implementation checklist +## Eligibility Requirements + +Please, address the following to make sure the propsal is elegible: - +- [ ] New category must group at least 5 integrations. +- [ ] Alternative existing categories in which these integrations are (currently) or could be (in the future) grouped. +- [ ] Proof that this label is a well-known industry vocab and not jargon used by a few. + - Usage of the keyword in Gartner or Forrester industry reports. + - Industry blogs using this label or keyword. + - Customer mentioning this keyword. +- [ ] Proof that users use this label to describe this subset of integrations. + - Enhancement requests that complain about the lack of this category. + - Full-story data reporting on average 50+ unique searches for this keyword per month in the integrations UI. + - Usage of this category for filtering purposes by our industry. +- [ ] Impact that are we expecting with this category and how we will measure it (success criteria) + +## Implementation checklist -- [] Support in package-spec manifest categories -- [] Support in package-registry /categories API -- [] Support in Fleet -- [] Update integrations dependencies to support new category +- [ ] Support in package-spec manifest categories +- [ ] Support in package-registry /categories API +- [ ] Support in Fleet +- [ ] Update integrations dependencies to support new category diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 486391394..dbc6529f9 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -31,7 +31,18 @@ something like this: ## Category Proposals -Specific changes regarding categories can please use the [new Category Proposal issue](https://github.com/elastic/package-spec/issues/new/choose). +Any changes on the categories supported by the Elastic Package Specification has to be discussed. The process is: + +1. A solutions team or an integration author creates a +[Category Proposal issue](https://github.com/elastic/package-spec/issues/new/choose) +in the package-spec repo requesting the addition of a new category. +2. Github issue provides details related to the category i.e. label, position, solution, etc. Answers to all the points in +the eligibility requirement and a plan or timeline to add a promised minimum set of integrations. +3. Ecosystem team assesses the request and makes a decision based on data points provided in the GitHub issue +4. If we are not able to address and the category doesn’t meet eligibility requirements, we as a business must assume that +this category is more harmful to our UX than the value it provides, and hence, must not be added. +5. If the decision is in favor of adding the category, the Ecosystem team will prioritize and work on the GitHub issue in +one of the releases under planning (future releases) ## Folder Item spec From 275ae4357739ef33c84ea441fc4a3e603bb5281a Mon Sep 17 00:00:00 2001 From: Tere Date: Wed, 3 Dec 2025 09:06:49 +0100 Subject: [PATCH 3/3] Apply suggestions from code review Co-authored-by: Jaime Soriano Pastor --- .github/ISSUE_TEMPLATE/Category_Proposal.md | 4 ++-- CONTRIBUTING.md | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/Category_Proposal.md b/.github/ISSUE_TEMPLATE/Category_Proposal.md index 48c989259..38b2db781 100644 --- a/.github/ISSUE_TEMPLATE/Category_Proposal.md +++ b/.github/ISSUE_TEMPLATE/Category_Proposal.md @@ -15,9 +15,9 @@ title: "[Category Proposal] " Please, address the following to make sure the propsal is elegible: -- [ ] New category must group at least 5 integrations. +- [ ] New category must group at least 5 integrations, existing or planned. List them here. - [ ] Alternative existing categories in which these integrations are (currently) or could be (in the future) grouped. -- [ ] Proof that this label is a well-known industry vocab and not jargon used by a few. +- [ ] Proof that this label is a well-known industry term and not jargon used by a few. - Usage of the keyword in Gartner or Forrester industry reports. - Industry blogs using this label or keyword. - Customer mentioning this keyword. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index dbc6529f9..21d98fb00 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -39,8 +39,8 @@ in the package-spec repo requesting the addition of a new category. 2. Github issue provides details related to the category i.e. label, position, solution, etc. Answers to all the points in the eligibility requirement and a plan or timeline to add a promised minimum set of integrations. 3. Ecosystem team assesses the request and makes a decision based on data points provided in the GitHub issue -4. If we are not able to address and the category doesn’t meet eligibility requirements, we as a business must assume that -this category is more harmful to our UX than the value it provides, and hence, must not be added. +4. If we are not able to address and the category doesn’t meet eligibility requirements, we can assume that +this category is more harmful to the UX than the value it provides, and hence, it must not be added. 5. If the decision is in favor of adding the category, the Ecosystem team will prioritize and work on the GitHub issue in one of the releases under planning (future releases)