From 87af84cddd742f48ad3ec195e7246797d2f1a407 Mon Sep 17 00:00:00 2001 From: Nick Bourdakos Date: Wed, 22 Mar 2023 13:32:17 -0700 Subject: [PATCH] Add issue templates PiperOrigin-RevId: 518658906 --- .github/ISSUE_TEMPLATE/bug_report.yml | 109 +++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.yml | 18 ++++ .github/ISSUE_TEMPLATE/question.md | 10 ++ README.md | 4 +- 4 files changed, 139 insertions(+), 2 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml create mode 100644 .github/ISSUE_TEMPLATE/question.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 00000000..20dadf91 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,109 @@ +name: 🐛 Bug Report +description: Report a reproducible bug or regression. +labels: + - 'needs-triage' + - 'type: bug' + +body: + - type: dropdown + attributes: + label: Project + description: Which project are you using? + options: + - Nearby Connections + - Fast Pair + - Nearby Presence + - Nearby for Embedded Systems + - Other + validations: + required: true + + - type: dropdown + attributes: + label: Language + description: Which client library are you using? + options: + - Swift + - C + - C++ + - Dart + - Other + validations: + required: true + + - type: dropdown + attributes: + label: OS Platform + description: Which operating system are you trying to use Nearby on? + options: + - Windows + - Linux + - Apple + - Other + validations: + required: true + + - type: textarea + attributes: + label: What happened? + description: | + Please provide as much info as possible. Not doing so may result in your bug not being addressed in a timely manner. + validations: + required: true + + - type: textarea + attributes: + label: What did you expect to happen? + validations: + required: true + + - type: textarea + attributes: + label: How can we reproduce it (as minimally and precisely as possible)? + placeholder: | + Example bug report: + 1. Start discovery on MacBook Air + 2. Start advertising on Pixel 7 Pro + 3. Attempt to connect to discovered Pixel + validations: + required: true + + - type: dropdown + attributes: + label: How often does this bug happen? + description: | + Following the repro steps above, how easily are you able to reproduce this bug? + options: + - Every time + - Often + - Sometimes + - Only once + validations: + required: true + + - type: textarea + attributes: + label: How can we reproduce it (as minimally and precisely as possible)? + placeholder: | + Example bug report: + 1. Start discovery on MacBook Air + 2. Start advertising on Pixel 7 Pro + 3. Attempt to connect to discovered Pixel + validations: + required: true + + - type: textarea + attributes: + label: Standalone code to reproduce the issue + description: Provide a reproducible test case that is the bare minimum necessary to generate the problem. + + - type: textarea + id: logs + attributes: + label: Relevant log output + description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks. + render: shell + + - type: textarea + attributes: + label: Anything else we need to know? diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 00000000..a8017f86 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,18 @@ +name: 🪄 Feature Request +description: Request a new feature or enhancement. +labels: + - 'needs-triage' + - 'type: feature-request' + +body: + - type: textarea + attributes: + label: What would you like to be added? + validations: + required: true + + - type: textarea + attributes: + label: Why is this needed? + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md new file mode 100644 index 00000000..9f7c6d65 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/question.md @@ -0,0 +1,10 @@ +--- +name: "🤔 Questions and Help" +about: Ask a general question (we may not have time to provide an answer) +labels: ['needs-triage', 'type: question'] +--- + + diff --git a/README.md b/README.md index b69cd18f..4dc13ba1 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ This is not an officially supported Google product. ## Projects -### [Nearby Connection](connections/) +### [Nearby Connections](connections/) A peer-to-peer networking API that allows apps to easily discover, connect to, and exchange data with nearby devices in real-time, regardless of network connectivity. @@ -28,4 +28,4 @@ We encourage you to contribute to Nearby! Please check out the [Contributing to ## License -Nearby is released under the [Apache License 2.0](LICENSE) \ No newline at end of file +Nearby is released under the [Apache License 2.0](LICENSE)