Skip to content

Commit

Permalink
Update issue templates (simplify and clarify the process) (#1771)
Browse files Browse the repository at this point in the history
Co-authored-by: Trask Stalnaker <[email protected]>
  • Loading branch information
lmolkova and trask authored Jan 21, 2025
1 parent efd7f1e commit 2eb5802
Show file tree
Hide file tree
Showing 3 changed files with 30 additions and 135 deletions.
27 changes: 7 additions & 20 deletions .github/ISSUE_TEMPLATE/bug_report.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,10 @@ body:
description: Which area(s) does your bug report concern? If none fits, please select `area:other`
multiple: true
options:
- docs
- tooling
- schema
- area:other
- area:docs
# NOTE: The list below is autogenerated using `make generate-gh-issue-templates`
# DO NOT manually edit it.
# Start semconv area list
Expand Down Expand Up @@ -90,27 +92,12 @@ body:
# End semconv area list
- type: textarea
attributes:
label: What happened?
description: Please provide as much detail as you reasonably can.
value: |
## Description
## Steps to Reproduce (if any)
## Expected Result
## Actual Result
validations:
required: true

- type: input
attributes:
label: Semantic convention version
description: What version did you use? (e.g., `v1.24.0`, `1eb551b`, etc)
label: What's the problem?
description: Please describe the problem as precisely as you reasonably can.
validations:
required: true

- type: textarea
attributes:
label: Additional context
description: Any additional information you think may be relevant to this issue.
label: Describe the solution you'd like
description: A clear and concise description of solution you'd like to see.
24 changes: 8 additions & 16 deletions .github/ISSUE_TEMPLATE/change_proposal.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
name: Propose changes to existing conventions
description: Propose changes you'd like to be added to existing conventions
labels: ["enhancement"]
name: Propose enhancement to existing conventions
description: Propose changes you'd like to see
body:
- type: dropdown
id: area
Expand All @@ -9,6 +8,9 @@ body:
description: Which area(s) does your change request concern?
multiple: true
options:
- docs
- tooling
- schema
# NOTE: The list below is autogenerated using `make generate-gh-issue-templates`
# DO NOT manually edit it.
# Start semconv area list
Expand Down Expand Up @@ -82,21 +84,11 @@ body:
# End semconv area list
- type: textarea
attributes:
label: Is your change request related to a problem? Please describe.
description: A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
label: What's missing?
description: Please describe the use-case or scenario that is not covered by the existing conventions.
validations:
required: true
- type: textarea
attributes:
label: Describe the solution you'd like
description: A clear and concise description of what you want to happen.
validations:
required: true
- type: textarea
attributes:
label: Describe alternatives you've considered
description: A clear and concise description of any alternative solutions or features you've considered.
- type: textarea
attributes:
label: Additional context
description: Add any other context or screenshots about the feature request here.
description: A clear and concise description of solution you'd like to see.
114 changes: 15 additions & 99 deletions .github/ISSUE_TEMPLATE/new-conventions.yaml
Original file line number Diff line number Diff line change
@@ -1,111 +1,27 @@
name: Propose new semantic conventions
description: Propose new conventions you'd like to be part of the OpenTelemetry project
description: Propose new conventions you'd like to see in the OpenTelemetry project
labels: ["enhancement", "experts needed"]
body:
- type: markdown
attributes:
value: |
Please make sure to fill out the entire form below, providing as much context as you can in order to help us triage the proposal as quickly as possible.
Thanks for your interest in contributing to the OpenTelemetry Semantic Conventions!
Before filing the proposal, please be sure you have searched through [existing issues](https://github.com/open-telemetry/semantic-conventions/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3Aenhancement+label%3Aarea:new) to see if an existing issue covers your proposal.
Substantial changes to the conventions follow [OTel project management]
(https://github.com/open-telemetry/community/blob/main/project-management.md) process
and usually require a group of people who are familiar with the domain,
are involved with instrumentation efforts, and are committed to be the point of contact for
pull requests, issues, and questions in this area.
Additionally, make sure to read and follow the guidelines on [Project Proposal](https://github.com/open-telemetry/community/blob/main/project-management.md#project-management), in case the proposal is for a new set of conventions/working group.
- type: dropdown
id: area
attributes:
label: Area(s)
description: Which area(s) does your new conventions concern? If none fits, please select `area:new`
multiple: true
options:
- area:new
# NOTE: The list below is autogenerated using `make generate-gh-issue-templates`
# DO NOT manually edit it.
# Start semconv area list
- area:android
- area:artifact
- area:aspnetcore
- area:aws
- area:azure
- area:browser
- area:cicd
- area:client
- area:cloud
- area:cloudevents
- area:cloudfoundry
- area:code
- area:container
- area:cpu
- area:db
- area:deployment
- area:destination
- area:device
- area:disk
- area:dns
- area:dotnet
- area:error
- area:exception
- area:faas
- area:feature-flag
- area:file
- area:gcp
- area:gen-ai
- area:geo
- area:go
- area:graphql
- area:hardware
- area:heroku
- area:host
- area:http
- area:jvm
- area:k8s
- area:linux
- area:log
- area:messaging
- area:network
- area:nodejs
- area:oci
- area:opentracing
- area:os
- area:otel
- area:peer
- area:process
- area:profile
- area:rpc
- area:security-rule
- area:server
- area:service
- area:session
- area:signalr
- area:source
- area:system
- area:telemetry
- area:test
- area:thread
- area:tls
- area:url
- area:user
- area:user-agent
- area:v8js
- area:vcs
- area:webengine
# End semconv area list
- type: textarea
attributes:
label: Is your change request related to a problem? Please describe.
description: A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
validations:
required: true
Creating a new issue here is a great first step to find others interested in collaborating.
- type: textarea
attributes:
label: Describe the solution you'd like
description: A clear and concise description of what you want to happen.
label: Propose new conventions
description: |
Please provide a brief description of the conventions, including
telemetry signals you'd like to define.
Consider specifying which instrumentations or systems would implement these
conventions and the benefits they would bring to the ecosystem.
validations:
required: true
- type: textarea
attributes:
label: Describe alternatives you've considered
description: A clear and concise description of any alternative solutions or features you've considered.
- type: textarea
attributes:
label: Additional context
description: Add any other context or screenshots about the feature request here.

0 comments on commit 2eb5802

Please sign in to comment.