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

docs: mandatory issue templates (AIDM-423) #11765

Merged
merged 1 commit into from
Dec 19, 2024

Conversation

tlhunter
Copy link
Member

@tlhunter tlhunter commented Dec 17, 2024

  • 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 for an example of how this will work

Checklist

  • PR author has checked that all the criteria below are met
  • The PR description includes an overview of the change
  • The PR description articulates the motivation for the change
  • The change includes tests OR the PR description describes a testing strategy
  • The PR description notes risks associated with the change, if any
  • Newly-added code is easy to change
  • The change follows the library release note guidelines
  • The change includes or references documentation updates if necessary
  • Backport labels are set (if applicable)

Reviewer Checklist

  • Reviewer has checked that all the criteria below are met
  • Title is accurate
  • All changes are related to the pull request's stated goal
  • Avoids breaking API changes
  • Testing strategy adequately addresses listed risks
  • Newly-added code is easy to change
  • Release note makes sense to a user of the library
  • If necessary, author has acknowledged and discussed the performance implications of this PR as reported in the benchmarks PR comment
  • Backport labels are set in a manner that is consistent with the release branch maintenance policy

@tlhunter tlhunter added the changelog/no-changelog A changelog entry is not required for this PR. label Dec 17, 2024
@tlhunter tlhunter requested review from a team as code owners December 17, 2024 23:21
Copy link
Contributor

CODEOWNERS have been resolved as:

.github/ISSUE_TEMPLATE/bug_report.yaml                                  @DataDog/python-guild @DataDog/apm-core-python
.github/ISSUE_TEMPLATE/config.yaml                                      @DataDog/python-guild @DataDog/apm-core-python
.github/ISSUE_TEMPLATE/feature_request.yaml                             @DataDog/python-guild @DataDog/apm-core-python
SECURITY.md                                                             @DataDog/apm-core-python

@pr-commenter
Copy link

pr-commenter bot commented Dec 17, 2024

Benchmarks

Benchmark execution time: 2024-12-19 22:43:26

Comparing candidate commit bc3908c in PR branch tlhunter/create-issue-standard with baseline commit f810101 in branch main.

Found 0 performance improvements and 0 performance regressions! Performance is the same for 394 metrics, 2 unstable metrics.

@tlhunter tlhunter enabled auto-merge (squash) December 18, 2024 21:06
@tlhunter tlhunter force-pushed the tlhunter/create-issue-standard branch from 8de249a to 348911e Compare December 18, 2024 21:07
@tlhunter tlhunter changed the title repo: mandatory issue templates (AIDM-423) docs: mandatory issue templates (AIDM-423) Dec 18, 2024
@tlhunter tlhunter force-pushed the tlhunter/create-issue-standard branch from 348911e to bc3908c Compare December 19, 2024 22:04
@tlhunter tlhunter merged commit 350307c into main Dec 19, 2024
211 checks passed
@tlhunter tlhunter deleted the tlhunter/create-issue-standard branch December 19, 2024 23:33
brettlangdon pushed a commit that referenced this pull request Dec 20, 2024
- the [create
issue](https://github.com/DataDog/dd-trace-py/issues/new/choose) screen
has issue templates but no external links
- the only difference I can see is that I used config.yaml whereas in
other repos it's config.yml
  - very confusing since the issue templates use .yaml...
- follow up to #11765

## Checklist
- [x] PR author has checked that all the criteria below are met
- The PR description includes an overview of the change
- The PR description articulates the motivation for the change
- The change includes tests OR the PR description describes a testing
strategy
- The PR description notes risks associated with the change, if any
- Newly-added code is easy to change
- The change follows the [library release note
guidelines](https://ddtrace.readthedocs.io/en/stable/releasenotes.html)
- The change includes or references documentation updates if necessary
- Backport labels are set (if
[applicable](https://ddtrace.readthedocs.io/en/latest/contributing.html#backporting))

## Reviewer Checklist
- [x] Reviewer has checked that all the criteria below are met 
- Title is accurate
- All changes are related to the pull request's stated goal
- Avoids breaking
[API](https://ddtrace.readthedocs.io/en/stable/versioning.html#interfaces)
changes
- Testing strategy adequately addresses listed risks
- Newly-added code is easy to change
- Release note makes sense to a user of the library
- If necessary, author has acknowledged and discussed the performance
implications of this PR as reported in the benchmarks PR comment
- Backport labels are set in a manner that is consistent with the
[release branch maintenance
policy](https://ddtrace.readthedocs.io/en/latest/contributing.html#backporting)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
changelog/no-changelog A changelog entry is not required for this PR.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants