From 44f36d3eefb41f38ca46a756d9fae1f5d2de681a Mon Sep 17 00:00:00 2001 From: Thomas Hunter II Date: Mon, 23 Dec 2024 13:09:40 -0800 Subject: [PATCH] repo: mandatory issue templates (AIDM-426) (#4235) * repo: mandatory issue templates * Update .github/ISSUE_TEMPLATE/config.yml Co-authored-by: Marco Costa * Update .github/ISSUE_TEMPLATE/config.yml Co-authored-by: Marco Costa * prompt for library name and version --------- Co-authored-by: Marco Costa --- .github/ISSUE_TEMPLATE/bug_report.md | 31 --------- .github/ISSUE_TEMPLATE/bug_report.yaml | 71 +++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 11 ++-- .github/ISSUE_TEMPLATE/feature_request.md | 23 ------- .github/ISSUE_TEMPLATE/feature_request.yaml | 50 +++++++++++++++ SECURITY.md | 15 +++++ spec/datadog/release_gem_spec.rb | 1 + 7 files changed, 144 insertions(+), 58 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yaml delete mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yaml create mode 100644 SECURITY.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index 4402e592e4e..00000000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -name: 🐛 Bug report -about: File a bug report -title: '' -labels: community, bug -assignees: '' - ---- - -**Current behaviour** - - -**Expected behaviour** - - -**Steps to reproduce** - - -**How does `datadog` help you?** - - -**Environment** - -* **datadog version:** -* **Configuration block (`Datadog.configure ...`):** -* **Ruby version:** -* **Operating system:** -* **Relevant library versions:** diff --git a/.github/ISSUE_TEMPLATE/bug_report.yaml b/.github/ISSUE_TEMPLATE/bug_report.yaml new file mode 100644 index 00000000000..d7a5eb59de8 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yaml @@ -0,0 +1,71 @@ +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: community, bug +body: + - type: input + attributes: + label: Tracer Version(s) + description: "Version(s) of the tracer affected by this bug" + placeholder: "1.23.4, 2.8.0" + validations: + required: true + + - type: input + attributes: + label: Ruby Version(s) + description: "Version(s) of Ruby (`ruby --version`) that you've encountered this bug with" + placeholder: "ruby 2.7.5p203 (2021-11-24 revision f69aeb8314) [arm64-darwin21]" + validations: + required: true + + - type: input + attributes: + label: Relevent Library and Version(s) + description: "The name of a library and version(s) that you've encountered this bug with" + placeholder: "mysql 2.9.1" + validations: + required: false + + - 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 + + - type: textarea + attributes: + label: Configuration Block + description: How is your tracer configured, e.g. `Datadog.configure ...` + validations: + required: false + + - type: textarea + attributes: + label: Error Logs + description: "Please provide any error logs from the tracer (`DD_TRACE_DEBUG=true` can help)" + validations: + required: false + + - type: input + attributes: + label: Operating System + description: "Provide your operating system and version (e.g. `uname -a`)" + placeholder: Darwin Kernel Version 23.6.0 + validations: + required: false + + - type: textarea + attributes: + label: How does Datadog Help You + description: "Optionally, tell us why and how you're using datadog, and what your overall experience with it is!" + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index 4b9879c5d0a..e669d6019cd 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1,5 +1,8 @@ -blank_issues_enabled: true +blank_issues_enabled: false contact_links: - - name: ℹī¸ Datadog Support - url: https://www.datadoghq.com/support/ - about: Get help from the Datadog support team + - 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:ruby + 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:ruby&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. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index 6c8802683b0..00000000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -name: 💡 Feature request -about: Suggest an idea for this project -title: '' -labels: community, feature-request -assignees: '' - ---- - -**Is your feature request related to a problem? Please describe.** - - -**Describe the goal of the feature** - - -**Describe alternatives you've considered** - - -**Additional context** - - -**How does `datadog` help you?** - diff --git a/.github/ISSUE_TEMPLATE/feature_request.yaml b/.github/ISSUE_TEMPLATE/feature_request.yaml new file mode 100644 index 00000000000..e04d76f7fb7 --- /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: community, feature-request +body: + - type: input + attributes: + label: Gem Name + description: "If your feature request is to add instrumentation support for a Ruby gem please provide the gem name here" + placeholder: mysql + validations: + required: false + + - type: input + attributes: + label: Gem Version(s) + description: "Please provide the version of the above gem here" + placeholder: 2.9.1 + validations: + required: false + + - type: textarea + attributes: + label: Describe the goal of the feature + description: A clear and concise goal 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 new file mode 100644 index 00000000000..9d59e4df672 --- /dev/null +++ b/SECURITY.md @@ -0,0 +1,15 @@ +# Security Policy + +This document outlines the security policy for the Datadog Ruby client library (aka Ruby 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. + +## Supported Versions + +We accept vulnerability submissions for the [currently maintained releases](https://github.com/DataDog/dd-trace-rb/releases). + +## Reporting a Vulnerability + +If you discover a vulnerability in the Datadog Ruby client library (or any Datadog product for that matter) please submit details to the following email address: + +* [security@datadoghq.com](mailto:security@datadoghq.com) diff --git a/spec/datadog/release_gem_spec.rb b/spec/datadog/release_gem_spec.rb index 24f9b022184..58e954a7ca4 100644 --- a/spec/datadog/release_gem_spec.rb +++ b/spec/datadog/release_gem_spec.rb @@ -27,6 +27,7 @@ |ext/.*/.clang-format |Appraisals |CONTRIBUTING.md + |SECURITY.md |Gemfile |(ruby|jruby)-\d+.\d+.gemfile |Rakefile