Skip to content

Commit 1a5985e

Browse files
authored
chore: mandatory issue templates (AIDM-428) (#175)
# Description - adds a bug report and feature request issue template - disables blank issue creation - adds a security document # Motivation - standardizes the create issue experience across tracers - see the [node.js create issue screen](https://github.com/DataDog/dd-trace-js/issues/new/choose) for an example of what this looks like # Additional Notes - does the C++ tracer instrument third party packages? I'm assuming not and have left such fields out - let me know if there's any other things you need to know (musl, glibc, etc) and we can add fields
1 parent febab81 commit 1a5985e

File tree

4 files changed

+98
-0
lines changed

4 files changed

+98
-0
lines changed
Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
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: textarea
15+
attributes:
16+
label: Bug Report
17+
description: Please add a clear and concise description of the bug here
18+
validations:
19+
required: true
20+
21+
- type: textarea
22+
attributes:
23+
label: Reproduction Code
24+
description: Please add code here to help us reproduce the problem
25+
validations:
26+
required: false
27+
28+
- type: textarea
29+
attributes:
30+
label: Error Logs
31+
description: "Please provide any error logs from the tracer"
32+
validations:
33+
required: false
34+
35+
- type: input
36+
attributes:
37+
label: Operating System
38+
description: "Provide your operating system and version (e.g. `uname -a`)"
39+
placeholder: Darwin Kernel Version 23.6.0
40+
validations:
41+
required: false

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
blank_issues_enabled: false
2+
contact_links:
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:proxy/c__
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. Please do not create a GitHub issue to report a bug.
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:proxy/c__&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. Please do not create a GitHub issue to request a feature.
Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
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: feature-request
5+
body:
6+
- type: textarea
7+
attributes:
8+
label: Describe the goal of the feature
9+
description: A clear and concise goal of what you want to happen.
10+
validations:
11+
required: true
12+
13+
- type: textarea
14+
attributes:
15+
label: Is your feature request related to a problem?
16+
description: |
17+
Please add a clear and concise description of your problem.
18+
E.g. I'm unable to instrument my database queries...
19+
validations:
20+
required: false
21+
22+
- type: textarea
23+
attributes:
24+
label: Describe alternatives you've considered
25+
description: A clear and concise description of any alternative solutions or features you've considered
26+
validations:
27+
required: false
28+
29+
- type: textarea
30+
attributes:
31+
label: Additional context
32+
description: Add any other context or screenshots about the feature request here
33+
validations:
34+
required: false

SECURITY.md

Lines changed: 15 additions & 0 deletions
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 C++ client library (aka C++ 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 release](https://github.com/DataDog/dd-trace-cpp/releases).
10+
11+
## Reporting a Vulnerability
12+
13+
If you discover a vulnerability in the Datadog C++ client library (or any Datadog product for that matter) please submit details to the following email address:
14+
15+

0 commit comments

Comments
 (0)