From 3d4aee263fa5582eb031282d5b51b6234cfe9d1e Mon Sep 17 00:00:00 2001 From: Justin Ibarra Date: Tue, 23 Feb 2021 11:16:03 -0900 Subject: [PATCH] Update issue templates (#956) --- .github/ISSUE_TEMPLATE/new_rule.md | 31 ++++++++++++------ .github/ISSUE_TEMPLATE/release_package.md | 37 ---------------------- .github/ISSUE_TEMPLATE/rule_deprecation.md | 5 +-- .github/ISSUE_TEMPLATE/rule_tuning.md | 5 ++- CONTRIBUTING.md | 1 - 5 files changed, 29 insertions(+), 50 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/release_package.md diff --git a/.github/ISSUE_TEMPLATE/new_rule.md b/.github/ISSUE_TEMPLATE/new_rule.md index f9df6d6da..b594bbe7a 100644 --- a/.github/ISSUE_TEMPLATE/new_rule.md +++ b/.github/ISSUE_TEMPLATE/new_rule.md @@ -1,32 +1,45 @@ --- name: New rule about: Suggestions and ideas for new rules -title: "[New Rule] " +title: "[New Rule] Name of rule" labels: "Rule: New" assignees: '' --- + + + ## Description ## Required Info -- **Eventing Sources:** - +### Target indexes + -- **Target Operating Systems:** +### Additional requirements + + +### Target Operating Systems -- **Platforms** +### Platforms -- **Target ECS Version:** x.x.x -- **New fields required in ECS for this?** -- **Related issues or PRs** +### Tested ECS Version +x.x.x + ## Optional Info -- **References:** + +### Query + +### New fields required in ECS/data sources for this rule? + +### Related issues or PRs + +### References diff --git a/.github/ISSUE_TEMPLATE/release_package.md b/.github/ISSUE_TEMPLATE/release_package.md deleted file mode 100644 index 893aec678..000000000 --- a/.github/ISSUE_TEMPLATE/release_package.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -name: Release package -about: Meta Issue for a package release -title: "[Release] package name or stack version" -labels: release-package -assignees: '' - ---- - - -## Required Info -**Stack Version:** -`{majorVersion.minorVersion}` - - -### Creation -Complete these items when creating this issue - -- [ ] Create a label for the rules package version as `X.X` and apply it -- [ ] Create [new milestone](https://github.com/elastic/detection-rules/milestones/new) with version as title -- [ ] Add this to the [detection-rules package tracking](https://github.com/orgs/elastic/projects/342) -- [ ] Add any existing issues and PRs that should be completed by this release -- [ ] Bump and lock versions (`build-packages --update-versions-file`) _before_ all BC testing and final merges to Kibana -- [ ] Pull Request to [Kibana](https://github.com/elastic/kibana) - - -#### Testing and Validation -- [ ] Create feature branch as `{majorVersion}.{minorVersion}` -- [ ] Tested and verified as custom or prepackaged rules -- [ ] Validate end-to-end -- [ ] Grammar checks -- [ ] UI checks for new rules - - -#### Post Release -- [ ] Tag and release as github artifact -- [ ] Merge feature branch into `main`. Don't squash commits, use rebase or merge with commits diff --git a/.github/ISSUE_TEMPLATE/rule_deprecation.md b/.github/ISSUE_TEMPLATE/rule_deprecation.md index 35d1aebcd..267239ed3 100644 --- a/.github/ISSUE_TEMPLATE/rule_deprecation.md +++ b/.github/ISSUE_TEMPLATE/rule_deprecation.md @@ -7,8 +7,9 @@ assignees: '' --- +## Link to rule + + ## Description Provide a detailed description of why the rule should be deprecated - -- **Link to rule file:** diff --git a/.github/ISSUE_TEMPLATE/rule_tuning.md b/.github/ISSUE_TEMPLATE/rule_tuning.md index d90cc9103..1e695fdaf 100644 --- a/.github/ISSUE_TEMPLATE/rule_tuning.md +++ b/.github/ISSUE_TEMPLATE/rule_tuning.md @@ -7,7 +7,10 @@ assignees: '' --- - + + +## Link to rule + ## Description diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0b66bd218..3f35004d5 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -46,7 +46,6 @@ We have a few types of issue templates to [choose from](https://github.com/elast * **Bug report**: Create a report to help us improve (not pertaining to rules) * **Feature request**: Suggest an idea for this project (not pertaining to rules) * **New rule**: Suggestions and ideas for new rules for the Detection Engine -* **Release package**: Used by the Elastic team to track a rules release * **Rule deprecation**: Recommend deprecating a rule that doesn't work or isn't useful anymore * **Tune existing rule**: Suggest changes to make to an existing rule to address false positives or negatives