Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Switch to mandatory issue templates #8106

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
61 changes: 61 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
name: "Bug Report (Low Priority)"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Was the low / high priority wording approved as a public facing support level?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We came up with it during the ideation phase a quarter ago, I believe the OSS team looked it over, and the Node.js tracer has been using it for months.

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.44.0"
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: 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
description: Please add a clear and concise description of the bug here
PerfectSlayer marked this conversation as resolved.
Show resolved Hide resolved
validations:
required: true

- type: textarea
attributes:
label: Expected Behavior
description: What is the expected behavior
validations:
required: true

- type: textarea
attributes:
label: Reproduction Code
description: Please add code here to help us reproduce the problem
validations:
required: false
10 changes: 5 additions & 5 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
blank_issues_enabled: true
blank_issues_enabled: false
contact_links:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What about all the other types of issue? Performance discussions, questions, help requests?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I can add additional templates for them. Other tracers either don't support freeform discussion or use the discussions tab. Are those three topics the finite list that you would like supported? Also, what default tags would you want applied?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would say it’s mainly performance related, or a question / help request.
I don’t know how the other tracers are handling it using GitHub?

- 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.
- 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.
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 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: "spring-boot"
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
12 changes: 9 additions & 3 deletions SECURITY.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
# 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 [email protected].
## 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:

* [[email protected]](mailto:[email protected])
Loading