Skip to content

Commit

Permalink
repo: mandatory issue templates (AIDM-423) (#11765)
Browse files Browse the repository at this point in the history
- adds two two issue templates
- disables freeform issues
- deletes an unused issue template file
- adds a security policy file
- 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 how this will work
  • Loading branch information
tlhunter authored Dec 19, 2024
1 parent 5cee25e commit 350307c
Show file tree
Hide file tree
Showing 5 changed files with 138 additions and 29 deletions.
29 changes: 0 additions & 29 deletions .github/ISSUE_TEMPLATE.md

This file was deleted.

64 changes: 64 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
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: 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: Python Version(s)
description: "Version(s) of Python (`python --version`) that you've encountered this bug with"
placeholder: "Python 3.9.15"
validations:
required: true

- type: input
attributes:
label: Pip Version(s)
description: "Version(s) of Pip (`pip --version`) that you've encountered this bug with"
placeholder: "pip 22.0.4"
validations:
required: true

- 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: Error Logs
description: "Please provide any error logs from the tracer (`DD_TRACE_DEBUG=true` can help)"
validations:
required: false

- type: textarea
attributes:
label: Libraries in Use
description: "Which libraries and their versions are you using? Paste output from `pip freeze` here."
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
9 changes: 9 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
blank_issues_enabled: false
contact_links:
- 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:python
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.
- 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:python&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. Please do not create a GitHub issue to request a feature.

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: feature-request
body:
- type: input
attributes:
label: Package Name
description: "If your feature request is to add instrumentation support for a package please provide the name here"
placeholder: mysql
validations:
required: false

- type: input
attributes:
label: Package Version(s)
description: "If your feature request is to add instrumentation support for a package please provide the version you use"
placeholder: 0.0.3
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 Python client library (aka Python 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 release](https://github.com/DataDog/dd-trace-py/releases).

## Reporting a Vulnerability

If you discover a vulnerability in the Datadog Python client library (or any Datadog product for that matter) please submit details to the following email address:

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

0 comments on commit 350307c

Please sign in to comment.