From e25a854d24464e0b00d58872ddf6dd9857d29ba7 Mon Sep 17 00:00:00 2001 From: Cameron Perera Date: Thu, 20 Feb 2025 09:20:31 -0600 Subject: [PATCH] =?UTF-8?q?docs:=20=E2=9C=8F=EF=B8=8F=20update=20bug=20rep?= =?UTF-8?q?ort=20template=20(#2695)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * docs: ✏️ update bug report template * docs: ✏️ update debug log info * docs: ✏️ small comment changes * docs: ✏️ add arch and os version examples * docs: ✏️ change App Version to Desktop Client Version * docs: ✏️ small change * docs: ✏️ another small change to bug template --- .github/ISSUE_TEMPLATE/bug_report.md | 60 ++++++++++++++++++++++------ 1 file changed, 48 insertions(+), 12 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index caa1c4ceb..ff41ea430 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -11,21 +11,57 @@ assignees: '' For questions, the best place to get answers is on our [discussion forum](https://discuss.hashicorp.com/c/boundary), as they will get more visibility from experienced users than the issue tracker. -Please note: We take Boundary's security and our users' trust very seriously. If you believe you have found a security issue in Boundary, please responsibly disclose by contacting us at security@hashicorp.com. Our PGP key is available at [our security page](https://www.hashicorp.com/security/). +Please note: We take Boundary's security and our users' trust very seriously. If you believe you have found a security issue in Boundary, please responsibly disclose this by contacting us at security@hashicorp.com. Our PGP key is available on [our security page](https://www.hashicorp.com/security/). + +Logging is available on Boundary Desktop Client version >= 2.1.0 + +Logs are found at: + +Linux: ~/.config/Boundary/logs/desktop-client.log +MacOS: ~/Library/Logs/Boundary/desktop-client.log +Windows: $env:USERPROFILE\AppData\Roaming\Boundary\logs\desktop-client.log + +If requests are taking longer than expected, please change the logging level to DEBUG. This will log the cache daemon request times as well. --> -**Describe the bug** -A clear and concise description of what the bug is. +## :bug: Bug Report -**To Reproduce** -Steps to reproduce the behavior: -1. Run `boundary authenticate ...` -2. Run `boundary connect ...` -3. See error +### **Description** -**Expected behavior** -A clear and concise description of what you expected to happen. +_A clear and concise description of the bug._ -**Additional context** -Add any other context about the problem here. +### **Steps to Reproduce** + +1. Go to '...' +2. Click on '...' +3. Scroll down to '...' +4. See the error + +## **Expected behavior** + +_A clear description of what you expected to happen._ + +## **Actual behavior** + +_A clear description of what actually happened._ + +## **Screenshots (if applicable)** + +_Add screenshots or screen recordings to help explain the issue._ + +## **Environment** + +- **OS and Version:** (e.g., Windows 10 (22H2), macOS (14.7.2)) +- **Architecture:** (e.g., arm64, x86_64) +- **Browser/Version:** (if applicable) +- **Desktop Client Version:** (if applicable) +- **Controller/worker versions:** (if applicable) + +## **Logs & Console Output (if applicable)** + +_Paste any relevant error logs or browser console output here._ + +## **Additional Context** + +_Any other details that might be relevant._