Skip to content

Commit 44f36d3

Browse files
tlhuntermarcotc
tlhunter
and
marcotc
authored
repo: mandatory issue templates (AIDM-426) (#4235)
* repo: mandatory issue templates * Update .github/ISSUE_TEMPLATE/config.yml Co-authored-by: Marco Costa <marco.costa@datadoghq.com> * Update .github/ISSUE_TEMPLATE/config.yml Co-authored-by: Marco Costa <marco.costa@datadoghq.com> * prompt for library name and version --------- Co-authored-by: Marco Costa <marco.costa@datadoghq.com>
1 parent c116d75 commit 44f36d3

File tree

7 files changed

+144
-58
lines changed

7 files changed

+144
-58
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.md

-31
This file was deleted.

‎.github/ISSUE_TEMPLATE/bug_report.yaml

+71
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
name: "Bug Report (Low Priority)"
2+
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."
3+
title: "[BUG]: "
4+
labels: community, bug
5+
body:
6+
- type: input
7+
attributes:
8+
label: Tracer Version(s)
9+
description: "Version(s) of the tracer affected by this bug"
10+
placeholder: "1.23.4, 2.8.0"
11+
validations:
12+
required: true
13+
14+
- type: input
15+
attributes:
16+
label: Ruby Version(s)
17+
description: "Version(s) of Ruby (`ruby --version`) that you've encountered this bug with"
18+
placeholder: "ruby 2.7.5p203 (2021-11-24 revision f69aeb8314) [arm64-darwin21]"
19+
validations:
20+
required: true
21+
22+
- type: input
23+
attributes:
24+
label: Relevent Library and Version(s)
25+
description: "The name of a library and version(s) that you've encountered this bug with"
26+
placeholder: "mysql 2.9.1"
27+
validations:
28+
required: false
29+
30+
- type: textarea
31+
attributes:
32+
label: Bug Report
33+
description: Please add a clear and concise description of the bug here
34+
validations:
35+
required: true
36+
37+
- type: textarea
38+
attributes:
39+
label: Reproduction Code
40+
description: Please add code here to help us reproduce the problem
41+
validations:
42+
required: false
43+
44+
- type: textarea
45+
attributes:
46+
label: Configuration Block
47+
description: How is your tracer configured, e.g. `Datadog.configure ...`
48+
validations:
49+
required: false
50+
51+
- type: textarea
52+
attributes:
53+
label: Error Logs
54+
description: "Please provide any error logs from the tracer (`DD_TRACE_DEBUG=true` can help)"
55+
validations:
56+
required: false
57+
58+
- type: input
59+
attributes:
60+
label: Operating System
61+
description: "Provide your operating system and version (e.g. `uname -a`)"
62+
placeholder: Darwin Kernel Version 23.6.0
63+
validations:
64+
required: false
65+
66+
- type: textarea
67+
attributes:
68+
label: How does Datadog Help You
69+
description: "Optionally, tell us why and how you're using datadog, and what your overall experience with it is!"
70+
validations:
71+
required: false

‎.github/ISSUE_TEMPLATE/config.yml

+7-4
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
1-
blank_issues_enabled: true
1+
blank_issues_enabled: false
22
contact_links:
3-
- name: ℹ️ Datadog Support
4-
url: https://www.datadoghq.com/support/
5-
about: Get help from the Datadog support team
3+
- name: Bug Report (High Priority)
4+
url: https://help.datadoghq.com/hc/en-us/requests/new?tf_1260824651490=pt_product_type:apm&tf_1900004146284=pt_apm_language:ruby
5+
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.
6+
- name: Feature Request (High Priority)
7+
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
8+
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.

‎.github/ISSUE_TEMPLATE/feature_request.md

-23
This file was deleted.

‎.github/ISSUE_TEMPLATE/feature_request.yaml

+50
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
name: Feature Request (Low Priority)
2+
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.
3+
title: "[FEATURE]: "
4+
labels: community, feature-request
5+
body:
6+
- type: input
7+
attributes:
8+
label: Gem Name
9+
description: "If your feature request is to add instrumentation support for a Ruby gem please provide the gem name here"
10+
placeholder: mysql
11+
validations:
12+
required: false
13+
14+
- type: input
15+
attributes:
16+
label: Gem Version(s)
17+
description: "Please provide the version of the above gem here"
18+
placeholder: 2.9.1
19+
validations:
20+
required: false
21+
22+
- type: textarea
23+
attributes:
24+
label: Describe the goal of the feature
25+
description: A clear and concise goal of what you want to happen.
26+
validations:
27+
required: true
28+
29+
- type: textarea
30+
attributes:
31+
label: Is your feature request related to a problem?
32+
description: |
33+
Please add a clear and concise description of your problem.
34+
E.g. I'm unable to instrument my database queries...
35+
validations:
36+
required: false
37+
38+
- type: textarea
39+
attributes:
40+
label: Describe alternatives you've considered
41+
description: A clear and concise description of any alternative solutions or features you've considered
42+
validations:
43+
required: false
44+
45+
- type: textarea
46+
attributes:
47+
label: Additional context
48+
description: Add any other context or screenshots about the feature request here
49+
validations:
50+
required: false

‎SECURITY.md

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Security Policy
2+
3+
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.
4+
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.
5+
This gives us an opportunity to release a fix for others to benefit from by the time details are made public.
6+
7+
## Supported Versions
8+
9+
We accept vulnerability submissions for the [currently maintained releases](https://github.com/DataDog/dd-trace-rb/releases).
10+
11+
## Reporting a Vulnerability
12+
13+
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:
14+
15+
* [security@datadoghq.com](mailto:security@datadoghq.com)

‎spec/datadog/release_gem_spec.rb

+1
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@
2727
|ext/.*/.clang-format
2828
|Appraisals
2929
|CONTRIBUTING.md
30+
|SECURITY.md
3031
|Gemfile
3132
|(ruby|jruby)-\d+.\d+.gemfile
3233
|Rakefile

0 commit comments

Comments
 (0)