From 1222afeb5475f0e6998a78d63a6cb9575e390814 Mon Sep 17 00:00:00 2001 From: Thomas Hunter II Date: Tue, 17 Dec 2024 14:30:36 -0800 Subject: [PATCH 1/5] repo: mandatory issue templates --- .github/ISSUE_TEMPLATE/bug_report.yaml | 34 ++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 10 ++--- .github/ISSUE_TEMPLATE/feature_request.yaml | 50 +++++++++++++++++++++ SECURITY.md | 16 +++++-- 4 files changed, 102 insertions(+), 8 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yaml create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yaml diff --git a/.github/ISSUE_TEMPLATE/bug_report.yaml b/.github/ISSUE_TEMPLATE/bug_report.yaml new file mode 100644 index 00000000000..43fa0a76766 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yaml @@ -0,0 +1,34 @@ +name: "Bug Report (Low Priority)" +description: "Create a public Bug Report. Note that these may not be addressed as quickly as the helpdesk and that looking up account information will be difficult." +title: "[BUG]: " +labels: "type: bug" +body: + - type: input + attributes: + label: Tracer Version(s) + description: "Version(s) of the tracer affected by this bug" + placeholder: "1.33.7" + validations: + required: true + + - type: input + attributes: + label: Java Version(s) + description: "Version(s) of Java (`java -version`) that you've encountered this bug with" + placeholder: 21.0.4 + validations: + required: true + + - type: textarea + attributes: + label: Bug Report + description: Please add a clear and concise description of the bug here + validations: + required: true + + - type: textarea + attributes: + label: Reproduction Code + description: Please add code here to help us reproduce the problem + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index 87aeff92856..41cd769edb3 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1,8 +1,8 @@ -blank_issues_enabled: true +blank_issues_enabled: false contact_links: - - name: Bug Report + - name: Bug Report (High Priority) url: https://help.datadoghq.com/hc/en-us/requests/new?tf_1260824651490=pt_product_type:apm&tf_1900004146284=pt_apm_language:java - about: This option creates an expedited Bug Report via the helpdesk (no login required). This will allow us to look up your account and allows you to provide additional information in private. - - name: Feature Request + about: Create an expedited Bug Report via the helpdesk (no login required). This will allow us to look up your account and allows you to provide additional information in private. Please do not create a GitHub issue to report a bug. + - name: Feature Request (High Priority) url: https://help.datadoghq.com/hc/en-us/requests/new?tf_1260824651490=pt_product_type:apm&tf_1900004146284=pt_apm_language:java&tf_1260825272270=pt_apm_category_feature_request - about: This option creates an expedited Feature Request via the helpdesk (no login required). This helps with prioritization and allows you to provide additional information in private. + about: Create an expedited Feature Request via the helpdesk (no login required). This helps with prioritization and allows you to provide additional information in private. Please do not create a GitHub issue to request a feature. diff --git a/.github/ISSUE_TEMPLATE/feature_request.yaml b/.github/ISSUE_TEMPLATE/feature_request.yaml new file mode 100644 index 00000000000..651b4b57848 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yaml @@ -0,0 +1,50 @@ +name: Feature Request (Low Priority) +description: Create a public Feature Request. Note that these may not be addressed as quickly as the helpdesk and that looking up account information will be difficult. +title: "[FEATURE]: " +labels: "type: feature request" +body: + - type: input + attributes: + label: Library Name + description: "If your feature request is to add instrumentation support for a library please provide the name here" + #placeholder: "TODO: Provide a sample Java library name" + validations: + required: false + + - type: input + attributes: + label: Library Version(s) + description: "If your feature request is to add instrumentation support for a library please provide the version you use" + placeholder: 1.2 + validations: + required: false + + - type: textarea + attributes: + label: Describe the feature you'd like + description: A clear and concise description of what you want to happen. + validations: + required: true + + - type: textarea + attributes: + label: Is your feature request related to a problem? + description: | + Please add a clear and concise description of your problem. + E.g. I'm unable to instrument my database queries... + validations: + required: false + + - type: textarea + attributes: + label: Describe alternatives you've considered + description: A clear and concise description of any alternative solutions or features you've considered + validations: + required: false + + - type: textarea + attributes: + label: Additional context + description: Add any other context or screenshots about the feature request here + validations: + required: false diff --git a/SECURITY.md b/SECURITY.md index 2346517a0aa..317ca8fe00e 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -1,5 +1,15 @@ -# Security +# Security Policy -## Security Vulnerabilities +This document outlines the security policy for the Datadog Java client library (aka Java tracer) and what to do if you discover a security vulnerability in the project. +Most notably, please do not share the details in a public forum (such as in a discussion, issue, or pull request) but instead reach out to us with the details. +This gives us an opportunity to release a fix for others to benefit from by the time details are made public. -If you have found a security issue, please contact the security team directly at security@datadoghq.com. +## Supported Versions + +We accept vulnerability submissions for the [currently maintained release](https://github.com/DataDog/dd-trace-java/releases). + +## Reporting a Vulnerability + +If you discover a vulnerability in the Datadog Java client library (or any Datadog product for that matter) please submit details to the following email address: + +* [security@datadoghq.com](mailto:security@datadoghq.com) From 43ae12080579123e3a80cb9b4d99807651b30c5d Mon Sep 17 00:00:00 2001 From: Thomas Hunter II Date: Wed, 18 Dec 2024 15:32:32 -0800 Subject: [PATCH 2/5] apply feedback from Bruce --- .github/ISSUE_TEMPLATE/bug_report.yaml | 13 ++++++++++--- .github/ISSUE_TEMPLATE/feature_request.yaml | 6 +++--- 2 files changed, 13 insertions(+), 6 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yaml b/.github/ISSUE_TEMPLATE/bug_report.yaml index 43fa0a76766..a23fe48b685 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yaml +++ b/.github/ISSUE_TEMPLATE/bug_report.yaml @@ -1,13 +1,13 @@ name: "Bug Report (Low Priority)" -description: "Create a public Bug Report. Note that these may not be addressed as quickly as the helpdesk and that looking up account information will be difficult." -title: "[BUG]: " +description: "Create a public Bug Report. Note that these may not be addressed as it depeonds on capacity and that looking up account information will be difficult." +title: "" labels: "type: bug" body: - type: input attributes: label: Tracer Version(s) description: "Version(s) of the tracer affected by this bug" - placeholder: "1.33.7" + placeholder: "1.44.0" validations: required: true @@ -26,6 +26,13 @@ body: validations: required: true + - type: textarea + attributes: + label: Expected Behavior + description: What is the expected behavior + validations: + required: true + - type: textarea attributes: label: Reproduction Code diff --git a/.github/ISSUE_TEMPLATE/feature_request.yaml b/.github/ISSUE_TEMPLATE/feature_request.yaml index 651b4b57848..902e20d3444 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.yaml +++ b/.github/ISSUE_TEMPLATE/feature_request.yaml @@ -1,13 +1,13 @@ name: Feature Request (Low Priority) -description: Create a public Feature Request. Note that these may not be addressed as quickly as the helpdesk and that looking up account information will be difficult. -title: "[FEATURE]: " +description: Create a public Feature Request. Note that these may not be addressed as it depeonds on capacity and that looking up account information will be difficult. +title: "" labels: "type: feature request" body: - type: input attributes: label: Library Name description: "If your feature request is to add instrumentation support for a library please provide the name here" - #placeholder: "TODO: Provide a sample Java library name" + placeholder: "spring-boot" validations: required: false From 5d4ea1c51be873c7a16bf9fe895f7966067b23c5 Mon Sep 17 00:00:00 2001 From: Thomas Hunter II Date: Wed, 18 Dec 2024 15:50:59 -0800 Subject: [PATCH 3/5] apply more feedback from Bruce --- .github/ISSUE_TEMPLATE/bug_report.yaml | 2 +- SECURITY.md | 4 ---- 2 files changed, 1 insertion(+), 5 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yaml b/.github/ISSUE_TEMPLATE/bug_report.yaml index a23fe48b685..9e2dd8339f5 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yaml +++ b/.github/ISSUE_TEMPLATE/bug_report.yaml @@ -14,7 +14,7 @@ body: - type: input attributes: label: Java Version(s) - description: "Version(s) of Java (`java -version`) that you've encountered this bug with" + description: "Version(s) of Java (`java --version`) that you've encountered this bug with" placeholder: 21.0.4 validations: required: true diff --git a/SECURITY.md b/SECURITY.md index 317ca8fe00e..537ae929868 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -4,10 +4,6 @@ This document outlines the security policy for the Datadog Java client library ( Most notably, please do not share the details in a public forum (such as in a discussion, issue, or pull request) but instead reach out to us with the details. This gives us an opportunity to release a fix for others to benefit from by the time details are made public. -## Supported Versions - -We accept vulnerability submissions for the [currently maintained release](https://github.com/DataDog/dd-trace-java/releases). - ## Reporting a Vulnerability If you discover a vulnerability in the Datadog Java client library (or any Datadog product for that matter) please submit details to the following email address: From 30f46b7cf3129e1795631ad989a5126db1b1c956 Mon Sep 17 00:00:00 2001 From: Thomas Hunter II Date: Thu, 19 Dec 2024 14:21:58 -0800 Subject: [PATCH 4/5] add dropdown for jvm vendor --- .github/ISSUE_TEMPLATE/bug_report.yaml | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yaml b/.github/ISSUE_TEMPLATE/bug_report.yaml index 9e2dd8339f5..0919f60576b 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yaml +++ b/.github/ISSUE_TEMPLATE/bug_report.yaml @@ -19,6 +19,26 @@ body: validations: required: true + - type: dropdown + attributes: + label: JVM Vendor + description: "Which JVM vendor does your application use" + options: + - Oracle JDK + - Alibaba Dragonwell + - Amazon Corretto + - Azul Zing / Zulu + - BellSoft Liberica JDK + - Eclipse Adoptium / Temurin + - Eclipse OpenJ9 + - IBM SDK / Semeru + - Oracle GraalVM + - RedHat JDK + - SapMachine + - Other (please specify in comments) + validations: + required: true + - type: textarea attributes: label: Bug Report From 9d5f4571a6fa1e5662928486252fa3a61374f3f4 Mon Sep 17 00:00:00 2001 From: Thomas Hunter II Date: Fri, 20 Dec 2024 13:14:01 -0800 Subject: [PATCH 5/5] update text --- .github/ISSUE_TEMPLATE/config.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index 41cd769edb3..67b8a3b1735 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -2,7 +2,7 @@ blank_issues_enabled: false contact_links: - name: Bug Report (High Priority) url: https://help.datadoghq.com/hc/en-us/requests/new?tf_1260824651490=pt_product_type:apm&tf_1900004146284=pt_apm_language:java - about: Create an expedited Bug Report via the helpdesk (no login required). This will allow us to look up your account and allows you to provide additional information in private. Please do not create a GitHub issue to report a bug. + about: Create an expedited Bug Report via the helpdesk (no login required). This will allow us to look up your account and allows you to provide additional information in private. - name: Feature Request (High Priority) url: https://help.datadoghq.com/hc/en-us/requests/new?tf_1260824651490=pt_product_type:apm&tf_1900004146284=pt_apm_language:java&tf_1260825272270=pt_apm_category_feature_request - about: Create an expedited Feature Request via the helpdesk (no login required). This helps with prioritization and allows you to provide additional information in private. Please do not create a GitHub issue to request a feature. + about: Create an expedited Feature Request via the helpdesk (no login required). This helps with prioritization and allows you to provide additional information in private.