Skip to content

Commit

Permalink
repo: mandatory issue templates (AIDM-426) (#4235)
Browse files Browse the repository at this point in the history
* repo: mandatory issue templates

* Update .github/ISSUE_TEMPLATE/config.yml

Co-authored-by: Marco Costa <[email protected]>

* Update .github/ISSUE_TEMPLATE/config.yml

Co-authored-by: Marco Costa <[email protected]>

* prompt for library name and version

---------

Co-authored-by: Marco Costa <[email protected]>
  • Loading branch information
tlhunter and marcotc authored Dec 23, 2024
1 parent c116d75 commit 44f36d3
Show file tree
Hide file tree
Showing 7 changed files with 144 additions and 58 deletions.
31 changes: 0 additions & 31 deletions .github/ISSUE_TEMPLATE/bug_report.md

This file was deleted.

71 changes: 71 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yaml
Original file line number Diff line number Diff line change
@@ -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
11 changes: 7 additions & 4 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -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.
23 changes: 0 additions & 23 deletions .github/ISSUE_TEMPLATE/feature_request.md

This file was deleted.

50 changes: 50 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yaml
Original file line number Diff line number Diff line change
@@ -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
15 changes: 15 additions & 0 deletions SECURITY.md
Original file line number Diff line number Diff line change
@@ -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:

* [[email protected]](mailto:[email protected])
1 change: 1 addition & 0 deletions spec/datadog/release_gem_spec.rb
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@
|ext/.*/.clang-format
|Appraisals
|CONTRIBUTING.md
|SECURITY.md
|Gemfile
|(ruby|jruby)-\d+.\d+.gemfile
|Rakefile
Expand Down

0 comments on commit 44f36d3

Please sign in to comment.