From 27a45953649af8f6c7ab784f53bd300fc6b05d8e Mon Sep 17 00:00:00 2001 From: Mateusz Rzeszutek Date: Fri, 25 Aug 2023 18:21:49 +0200 Subject: [PATCH] Update issue templates, add `needs triage` label (#9306) --- .github/ISSUE_TEMPLATE/bug_report.md | 31 -------------- .github/ISSUE_TEMPLATE/bug_report.yml | 50 ++++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 10 +++++ .github/ISSUE_TEMPLATE/feature_request.md | 19 -------- .github/ISSUE_TEMPLATE/feature_request.yml | 24 +++++++++++ 5 files changed, 84 insertions(+), 50 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml delete mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index 3d8b527b44..0000000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -name: Bug report -about: Create a report to help us improve -title: "" -labels: bug -assignees: "" ---- - -**Describe the bug** -A clear and concise description of what the bug is. - -**Steps to reproduce** -If possible, provide a recipe for reproducing the error. - -**What did you expect to see?** -A clear and concise description of what you expected to see. - -**What did you see instead?** -A clear and concise description of what you saw instead. - -**What version are you using?** -(e.g., `v0.9.0`, `393e4a2`, etc) - -**Environment** -Compiler: (e.g., "Temurin 17.0.7") -OS: (e.g., "Ubuntu 20.04") -Runtime (if different from JDK above): (e.g., "Oracle JRE 8u251") -OS (if different from OS compiled on): (e.g., "Windows Server 2019") - -**Additional context** -Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 0000000000..69009d589f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,50 @@ +name: Bug report +description: Create a report to help us improve +labels: ["bug", "needs triage"] +body: + - type: textarea + attributes: + label: Describe the bug + description: A clear and concise description of what the bug is. + validations: + required: true + - type: textarea + attributes: + label: Steps to reproduce + description: A recipe for reproducing the error. If possible, provide a link to a repository containing an executable repro scenario. + validations: + required: true + - type: textarea + attributes: + label: Expected behavior + description: A clear and concise description of what you expected to see. + validations: + required: true + - type: textarea + attributes: + label: Actual behavior + description: A clear and concise description of what you saw instead. + validations: + required: true + - type: input + attributes: + label: Javaagent or library instrumentation version + description: (e.g., `v0.9.0`, `393e4a2`, etc) + validations: + required: true + - type: textarea + attributes: + label: Environment + description: | + Runtime environment information, including the runtime JDK distribution, OS, used library versions, javaagent configuration, etc. + Example: + > JDK: Temurin 17.0.7 + > OS: Ubuntu 20.04 + > Spring Boot 2.7.15, Hibernate 5.0.0, ... + value: | + **JDK**: + **OS**: + - type: textarea + attributes: + label: Additional context + description: Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000000..501711ccac --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,10 @@ +contact_links: + - name: GitHib Discussions + url: https://github.com/open-telemetry/opentelemetry-java-instrumentation/discussions/new/choose + about: Please ask questions here. + - name: StackOverflow + url: https://stackoverflow.com/questions/ask?tags=open-telemetry+java + about: Or on StackOverflow. + - name: Slack + url: https://cloud-native.slack.com/archives/C014L2KCTE3 + about: Or the `#otel-java` channel in the CNCF Slack instance. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index 8e47557f98..0000000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -name: Feature request -about: Suggest an idea for this project -title: "" -labels: enhancement -assignees: "" ---- - -**Is your feature request related to a problem? Please describe.** -A clear and concise description of what the problem is. - -**Describe the solution you'd like** -A clear and concise description of what you want to happen. - -**Describe alternatives you've considered** -A clear and concise description of any alternative solutions or features you've considered. - -**Additional context** -Add any other context or screenshots about the feature request here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 0000000000..35a6dbeefb --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,24 @@ +name: Feature request +description: Suggest an idea for this project +labels: ["enhancement", "needs triage"] +body: + - type: textarea + attributes: + label: Is your feature request related to a problem? Please describe. + description: A clear and concise description of what the problem is. + 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.